Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uses values from constants in documentation #5806

Merged
merged 1 commit into from
Sep 21, 2024
Merged

Conversation

sebastienros
Copy link
Member

@sebastienros sebastienros commented Sep 20, 2024

There were some discrepancies between the code documentation and the actual values. This suggested pattern will prevent that, or at least make it obvious to update or catch in PRs by having the summary close to the actually value.

This is how it looks after:

image

Microsoft Reviewers: Open in CodeFlow

@sebastienros
Copy link
Member Author

Note that is also works with private constants, so if there are other places in doc where we reference some default values, like a default port (8080) we could do the same.

Copy link
Member

@eerhardt eerhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this is all of them, this looks great! Thanks

@davidfowl
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@sebastienros sebastienros merged commit 29b65d8 into main Sep 21, 2024
11 checks passed
@sebastienros sebastienros deleted the sebros/constantdoc branch September 21, 2024 17:38
@wangj90 wangj90 mentioned this pull request Oct 10, 2024
16 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Oct 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants