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

Unify style in config support info #1537

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

EliahKagan
Copy link
Member

This builds on b31d6b7 (#1531) by adjusting the capitalization and quoting style of string arguments in progress.rs that help document the status of what configuration options are and are not planned.

  • Since I believe these strings are not usually rendered as Markdown, and most places that code formatting in Markdown would be used were already written with single quotes, this applies that quoting style consistently.
  • This applies initial capitalization, which was sometimes but not always done. It does not apply a consistent style for when a string will end in a ., which seems already to differ deliberately for reasons of clarity. That can be adjusted later.
  • A small amount of minor rewording for clarity is also included.

This builds on b31d6b7 (GitoxideLabs#1531) by adjusting the capitalization and
quoting style of string arguments in `progress.rs` that help
document the status of what configuration options are and are not
planned.

- Since I believe these strings are not usually rendered as
  Markdown, and most places that code formatting in Markdown would
  be used were already written with single quotes, this applies
  that quoting style consistently.

- This applies initial capitalization, which was sometimes but not
  always done. It does not apply a consistent style for when a
  string will end in a `.`, which seems already to differ
  deliberately for reasons of clarity. That can be adjusted later.

- A small amount of minor rewording for clarity is also included.
@EliahKagan
Copy link
Member Author

EliahKagan commented Aug 22, 2024

I've prefixed the commit message title with doc: as suggested in #1531 (review). However, your wording there suggests that the effect is not certain. If you prefer not to deal with that at the same time as the release-related complexities discussed in comments at f218578, then I can amend this to remove the doc: prefix. My guess is that it's fine and you may want it, though, so I'll leave it in place unless you request a change.

Copy link
Member

@Byron Byron left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this improvement, it's much appreciated.

Let's try doc:, it should work.

@Byron Byron merged commit 472fe5f into GitoxideLabs:main Aug 23, 2024
19 checks passed
@EliahKagan EliahKagan deleted the progress-style branch August 23, 2024 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants