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

docs: Refinery Rules copyediting #731

Merged
merged 8 commits into from
Jun 21, 2023
Merged

docs: Refinery Rules copyediting #731

merged 8 commits into from
Jun 21, 2023

Conversation

mjingle
Copy link
Contributor

@mjingle mjingle commented Jun 21, 2023 •
edited
Loading

Which problem is this PR solving?

This PR hopes to make the generated rules.yaml file and associated documentation the best that it can be.

Short description of the changes

  • Add codeblock formatting for fields
  • Clarify existing wording
  • Check and standardize "weigh" vs. "weight" use
  • Check/Standardize use of Sampler Names in description text

@mjingle mjingle added the wip Work In Progress label Jun 21, 2023
@mjingle mjingle requested a review from a team as a code owner June 21, 2023 18:15
@TylerHelmuth TylerHelmuth changed the title Refinery Rules copyediting docs: Refinery Rules copyediting Jun 21, 2023
kentquirk
kentquirk approved these changes Jun 21, 2023
View reviewed changes
Copy link
Contributor

@kentquirk kentquirk left a comment

Choose a reason for hiding this comment

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

This is awesome. Thank you. I'll regenerate the other files after this merges.

@kentquirk kentquirk removed the wip Work In Progress label Jun 21, 2023
mjingle added 8 commits June 21, 2023 17:03
@mjingle @kentquirk
Copyediting first pass
594cfbd 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Complete If/then transitions
5fb8a0d 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Undo weight -> weigh changes
8b18f4f 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Missing if/then
9119f3d 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Apply wrap column to descriptions
b01fbb4 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Truly apply wrap column to descriptions
15ab5a0 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Incorporate clarification feedback
54dbbd7 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Standardize Sampling names in descriptions
f14bf3b 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@kentquirk kentquirk merged commit 765819f into main Jun 21, 2023
@kentquirk kentquirk deleted the mj.RulesReview branch June 21, 2023 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kentquirk kentquirk kentquirk approved these changes

@TylerHelmuth TylerHelmuth TylerHelmuth approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@mjingle @kentquirk @TylerHelmuth