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

Minor changes to package management tutorial #10975

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gridbugs
Copy link
Collaborator

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

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>
@gridbugs gridbugs added docs Documentation improvements package management labels Sep 30, 2024
@gridbugs
Copy link
Collaborator Author

I finally got around to doing the package management tutorial. It's great! I've made a couple of minor tweaks here and there.

@Alizter
Copy link
Collaborator

Alizter commented Sep 30, 2024

Does replacing sh with console give better highlighting?

@gridbugs
Copy link
Collaborator Author

gridbugs commented Oct 1, 2024

I tried replacing sh with console but it didn't seem to add any highlighting for console sessions.

Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a 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".
Copy link
Collaborator

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 :)

Copy link
Collaborator Author

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements package management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants