Enforce API documentation#160
Open
pravic wants to merge 1 commit into
Open
Conversation
loyd
reviewed
Sep 27, 2024
Currently almost nobody documents added functions which is not good for the users of this library - but the API must have documentation. Let's warn about missing docs (deny would be even better).
Contributor
Author
Collaborator
I agree; we need to force the creation of documentation for all new extensions. |
9 tasks
18 tasks
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
3 participants
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.
Summary
Currently almost nobody documents added functions which is not good for the users of this library - but the API must have documentation.
Let's warn about missing docs (deny would be even better).