autodoc.pl: Generate missing pod for back-compat symbols - #24641
Merged
Conversation
jkeenan
changed the title
Contributor
Author
|
Here's a sample of the end result
No further documentation is currently available. |
It's a pain to write documentation. That helps explain why We have >3K undocumented symbols visible to the outside world. With symbols that are retained just for backwards compatibility, that may well be all that a module maintainer needs to know: Don't use it for new code. And that pod can be automatically generated. This commit adds that ability and uses it for 4 symbols. There are dozens more that could benefit from this, but I'm starting with just these to get people's reactions.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
It's a pain to write documentation. That helps explain why We have >3K undocumented symbols visible to the outside world.
With symbols that are retained just for backwards compatibility, that may well be all that a module maintainer needs to know: Don't use it for new code. And that pod can be automatically generated.
This commit adds that ability and uses it for 4 symbols. There are dozens more that could benefit from this, but I'm starting with just these to get people's reactions.