add @diagnostics field - sf id: 1887564, re #1 #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch adds a new field, called @diagnostics, which is treated like other indexed fields, such as @todo, and @bug. The idea behind the patch is to allow developers to create diagnostics sections in their documentation, that contains a list of error messages that the code generates, along with a snippet of text about what it means. For example: @diagnostics: C{Unrecognized token in config file: %s} The config file contained an invalid token. This may be caused by a typo, if you edited the file by hand, or the pluralization of a keyword where the singular was expected. If you haven't changed the file by hand, the config file may have been created with an earlier version of the software, which had a slightly different format. See the "Config Files" section if the upgrade documentation. The attached patch fixes the epydoc docstring parser, docwriter, and the documentation. It makes no changes to documentation generated in Latex, or with the javaDoc or reStructuredText formats. Testing has been adhoc, and no additional test cases were added to the doctests. https://sourceforge.net/support/tracker.php?aid=1887564 Signed-off-by: Johannes Dewender <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch adds a new field, called @diagnostics, which is treated like
other indexed fields, such as @todo, and @bug.
The idea behind the patch is to allow developers to create diagnostics
sections in their documentation, that contains a list of error messages
that the code generates, along with a snippet of text about what it
means. For example:
@diagnostics: C{Unrecognized token in config file: %s}
The config file contained an invalid token. This may be caused by a
typo, if you edited the file by hand, or the pluralization of a keyword
where the singular was expected. If you haven't changed the file by
hand, the config file may have been created with an earlier version of
the software, which had a slightly different format. See the "Config
Files" section if the upgrade documentation.
The attached patch fixes the epydoc docstring parser, docwriter, and the
documentation. It makes no changes to documentation generated in Latex,
or with the javaDoc or reStructuredText formats.
Testing has been adhoc, and no additional test cases were added to the
doctests.
https://sourceforge.net/support/tracker.php?aid=1887564