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.

Sign up for GitHub

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

Jump to bottom

doc: improve rate default documentation #364

Merged
merged 4 commits into from
May 1, 2023
Merged

doc: improve rate default documentation #364

merged 4 commits into from
May 1, 2023

Conversation

bernhardreiter
Copy link
Member

  • add rate default to download and checker options, using the description field
    in the struct tag because we leave the value at nil by default.
  • use the same phrasing in the aggregator docs to be consistent

solve #359

@bernhardreiter bernhardreiter linked an issue Apr 27, 2023 that may be closed by this pull request
Document default for Rate options consistently #359
Closed
@bernhardreiter
Copy link
Member Author

solve #359

This was the wrong keyword to link the issue automatically, so I did it manually, what would have worked is resolve #359 (and another condition is that it is a pull request to the standard branch).

https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

JanHoefelmeyer
JanHoefelmeyer previously approved these changes Apr 27, 2023
View reviewed changes
Copy link
Contributor

@JanHoefelmeyer JanHoefelmeyer left a comment

Choose a reason for hiding this comment

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

LGTM

s-l-teichmann
s-l-teichmann previously approved these changes Apr 27, 2023
View reviewed changes
Copy link
Contributor

@s-l-teichmann s-l-teichmann left a comment

Choose a reason for hiding this comment

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

This one is fine now .... LGTM

tschmidtb51
tschmidtb51 previously approved these changes May 1, 2023
View reviewed changes
Copy link
Collaborator

@tschmidtb51 tschmidtb51 left a comment

Choose a reason for hiding this comment

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

LGTM

@tschmidtb51 tschmidtb51 dismissed stale reviews from s-l-teichmann and themself via c50990f May 1, 2023 18:24
tschmidtb51
tschmidtb51 approved these changes May 1, 2023
View reviewed changes
Copy link
Collaborator

@tschmidtb51 tschmidtb51 left a comment

Choose a reason for hiding this comment

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

LGTM - just fixed a minor spelling mistake and a missing phrase (doc/csaf_checker.md)

s-l-teichmann
s-l-teichmann approved these changes May 1, 2023
View reviewed changes
Copy link
Contributor

@s-l-teichmann s-l-teichmann left a comment

Choose a reason for hiding this comment

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

LGTM ... even better with the correct spelling. ;-)

@s-l-teichmann s-l-teichmann merged commit 8ad805e into main May 1, 2023
@s-l-teichmann s-l-teichmann deleted the add-rate-doc branch May 11, 2023 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@s-l-teichmann s-l-teichmann s-l-teichmann approved these changes

@tschmidtb51 tschmidtb51 tschmidtb51 approved these changes

@JanHoefelmeyer JanHoefelmeyer Awaiting requested review from JanHoefelmeyer

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document default for Rate options consistently
4 participants
@bernhardreiter @s-l-teichmann @tschmidtb51 @JanHoefelmeyer