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

nixos/docs: fix typo #372394

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion nixos/lib/test-driver/src/test_driver/machine.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"""
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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(&quot;foobar   &quot;)</code> will type the string <code class="literal">foobar</code>
---
> e.g., <code class="literal">send_chars(&quot;foobar\n&quot;)</code> will type the string <code class="literal">foobar</code>

Copy link
Member

Choose a reason for hiding this comment

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

ok that makes sense

Simulate typing a sequence of characters on the virtual keyboard,
e.g., `send_chars("foobar\n")` will type the string `foobar`
followed by the Enter key.
Expand Down