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

Revise and somewhat expand Prepare docs #1813

Merged
merged 1 commit into from
Jan 26, 2025

Conversation

EliahKagan
Copy link
Member

Closes #1799

This revises the gix_command::Prepare documentation, mainly for clarity but also to add some information and cover or explain some cases that were not (or not as fully) covered before.

This builds on recent documentation changes, such as those in #1800. In so doing, I believe it completes the last remaining task of #1799, among other changes.

Less importantly, this also:

  • Wraps Prepare documentation comments to a more consistent width, when doing so improved unrendered readability.
  • Made a trace message more precise, to avoid obscuring a subtlety about the distinction between what we are looking for and what we are adding, since that might occasionally relate to the reason someone is examining trace messages.

Although this is in part motivated by the documentation improvements in #1800 and by the goal of further clarifying the meaning of the various methods that are affected there, this does not do anything related to the \-related concerns presented in #1800 (comment). The changes here are completely independent of that.

This revises the `gix_command::Prepare` documentation, mainly for
clarity but also to add some information and cover or explain some
cases that were not (or not as fully) covered before.

This builds on recent documentation changes, such as those in GitoxideLabs#1800.

Less importantly, this also:

- Wraps `Prepare` documentation comments to a more consistent
  width, when doing so improved unrendered readability.

- Made a trace message more precise, to avoid obscuring a subtlety
  about the distinction between what we are looking for and what we
  are adding, since that might occasionally relate to the reason
  someone is examining trace messages.
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 helping with this! It's probably close to perfect now in terms of documentation.

If there was such a thing, it feels like this crate is approaching maturity even though I keep thinking that allow_*/disallow_* should rather be with_*(bool). Also I thought that there should be no 'double-duty' methods that do two things at once.

gix-command/src/lib.rs Show resolved Hide resolved
gix-command/src/lib.rs Show resolved Hide resolved
gix-command/src/lib.rs Show resolved Hide resolved
gix-command/src/lib.rs Show resolved Hide resolved
@Byron Byron merged commit 38a0d9a into GitoxideLabs:main Jan 26, 2025
21 checks passed
@EliahKagan EliahKagan deleted the prepare-doc branch January 26, 2025 14:47
@EliahKagan
Copy link
Member Author

it feels like this crate is approaching maturity

Before bringing it to 1.0.0, it might be best to wait until more has been done related to running commands on different platforms and environments, including running hooks on Windows, to see if that entails any changes to the interface itself. (I assume this may also motivate changes to the implementation including currently existing parts of it, but I think that's separate from what you mean, since changes to the implementation would usually be non-breaking as far as the interface is concerned.)

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.

sh quoting of program names on an opt-in basis
2 participants