{{ message }}
This repository was archived by the owner on Jan 12, 2024. It is now read-only.
Add API documentation linting to docgen step#1045
Draft
cgranade wants to merge 8 commits into
Draft
Conversation
Contributor
Contributor
Author
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 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.
This draft PR adds new functionality to the docgen step to check for common documentation errors and to expose them to the user. Each linting rule can be turned off, to warning level, or promoted to errors by setting the new
<QSharpDocsLintingRules>MSBuild property. My goal with this would be to use the new rules to help improve API documentation in the libraries and runtime repos, with an eventual aim of promoting all docs linting rules to errors.There's still a lot of code quality things left to be done (esp. adding API documentation to new types in this PR), but I wanted to open this up for early feedback and see if this could be a reasonable direction to help improve our API docs. Thanks!