Improve documentation and validate during CI #6949
Merged
Conversation
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
The API documentation generation is useful (in `--strict` mode) to determine whether all our APIs have sufficient documentation. Add a `--validate-only` mode that will run the validation without emitting the API JSON. This is useful for ensuring that the documentation is complete.
Run our documentation generator in "validate only" mode to ensure that new changes coming in to the repository have documented our changes fully.
The `git_reflog_entry__alloc` function is not actually defined, nor used. Remove references to it in the headers. It is not clear why the corresponding `__free` is, or should be, exported. Make it internal to the library.
0f6bbc8 to
338ceb9
Compare
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.
Add documentation for all our APIs, their parameters, and return information.
Add a CI validation step that uses our new documentation generator to ensure that we have complete documentation for our APIs.