nixos/docs: fix typo #372394
Open
nixos/docs: fix typo #372394
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If that string wasn't a raw string, the "\n" in the second line won't get rendered as such, but as a space instead.
github-actions
bot
added
6.topic: nixos
qxrein
reviewed
Jan 9, 2025
| @@ -726,7 +726,7 @@ def tty_matches(last: bool) -> bool: | |||
| retry(tty_matches, timeout) | |||
|
|
|||
| def send_chars(self, chars: str, delay: float | None = 0.01) -> None: | |||
| """ | |||
| r""" | |||
There was a problem hiding this comment.
why do you think raw string docstring is needed here?
tbh there's no need for this because docstring was already displaying \n correctly because it was inside backticks which preserve literal characters.
There was a problem hiding this comment.
Backticks might preserve literal characters in the language the docs are written in, but they don't in python code. Diffing the docs before and after my commit show that this change does affect the docs.
$ diff before/share/doc/nixos/index.html after/share/doc/nixos/index.html
9c9
< <script src="./highlightjs/highlight.pack.js" type="text/javascript"></script><script src="./highlightjs/loader.js" type="text/javascript"></script><script src="./anchor.min.js" type="text/javascript"></script><script src="./anchor-use.js" type="text/javascript"></script><script src="/nix/store/jbb6003fi70xmszwrfk3r70sdjcmaji5-nixos-manual-html/share/doc/nixos/index-redirects.js" type="text/javascript"></script>
---
> <script src="./highlightjs/highlight.pack.js" type="text/javascript"></script><script src="./highlightjs/loader.js" type="text/javascript"></script><script src="./anchor.min.js" type="text/javascript"></script><script src="./anchor-use.js" type="text/javascript"></script><script src="/nix/store/dg0pkw0y31cdhjyz7xd4ii719zh450pj-nixos-manual-html/share/doc/nixos/index-redirects.js" type="text/javascript"></script>
9203c9203
< e.g., <code class="literal">send_chars("foobar ")</code> will type the string <code class="literal">foobar</code>
---
> e.g., <code class="literal">send_chars("foobar\n")</code> will type the string <code class="literal">foobar</code>
qxrein
approved these changes
Jan 9, 2025
| @@ -726,7 +726,7 @@ def tty_matches(last: bool) -> bool: | |||
| retry(tty_matches, timeout) | |||
|
|
|||
| def send_chars(self, chars: str, delay: float | None = 0.01) -> None: | |||
| """ | |||
| r""" | |||
wegank
added
the
12.approvals: 1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If that string wasn't a raw string, the "\n" in the second line won't get rendered as such, but as a space instead.
Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.