octave-patch-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Octave-patch-tracker] [patch #8666] doc: adjusting octave examples test


From: Carnë Draug
Subject: [Octave-patch-tracker] [patch #8666] doc: adjusting octave examples test to exactly match output
Date: Fri, 27 Aug 2021 14:31:23 -0400 (EDT)
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0

Follow-up Comment #6, patch #8666 (project octave):

> What is the final goal of this patch?

The goal of this patch is twofold:

1) ensure that the examples in the documentation are valid (if a function
changes behaviour but someone forgets to update the documentation accordingly,
the doctest package will be able to catch it)

2) increase the available tests (because code examples now become tests as
well).

> I think it is more useful to add the examples as BIST into that function as
well. 

Sure, more BISTS are fine. But we don't want to remove examples from the
documentation. This approach, use the doctest package, is better in that you
don't need to duplicate them. An example code automatically becomes a BIST.


    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/patch/?8666>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/




reply via email to

[Prev in Thread] Current Thread [Next in Thread]