-
Notifications
You must be signed in to change notification settings - Fork 400
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
Minor changes to package management tutorial #10975
base: main
Are you sure you want to change the base?
Conversation
A couple of minor rewords and formatting changes: - Removed the `sh` syntax highlighting on terminal sessions (anything starting with a `$`) to prevent unintentionally-highlighted words, such as the "for" in "Solution for dune.lock:". - Removed some unnecessary commas - A note about removing the version constraints from the `fmt` dependency as readers will probably forget to do this (I did!) and the resulting solver error is hard to read. - Clarified some text about pinning Signed-off-by: Stephen Sherratt <stephen@sherra.tt>
I finally got around to doing the package management tutorial. It's great! I've made a couple of minor tweaks here and there. |
Does replacing |
I tried replacing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the improvements. Looks good but I think I would want @christinerose to comment on the full-stop-in-quotes thing.
sources for packages; for example, if the package is not released in a package | ||
repository. This is called "pinning." | ||
sources of packages; for example, if the package is not released in a package | ||
repository. This is called "pinning". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this change was deliberately done by @christinerose?
This seems to be a difference between [american and british english]. Personally I prefer the full stop to be outside the quote (as this also matches the typographic conventions of most other western languages) but I will defer the decision to native speakers :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, I'll defer this decision to @christinerose. I feel like I'm about to learn something about english (or at least american english).
A couple of minor rewords and formatting changes:
sh
syntax highlighting on terminal sessions (anything starting with a$
) to prevent unintentionally-highlighted words, such as the "for" in "Solution for dune.lock:".fmt
dependency as readers will probably forget to do this (I did!) and the resulting solver error is hard to read.