Add header description to e2doc #2474
Closed
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.
Very minor change to e2doc and e2descriptions that makes it so you can have more text than just function descriptions in the generated documentation. An example output is provided in the wiki.
Part of my plans to improve the documentation.
I was unsure how to store the description so I figured reserving identifiers starting with
_doc_surely couldn't be the worst way.This can, of course, be changed if it causes problems.