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

Use the kbd role in the doc #34629

Closed
fchapoton opened this issue Oct 2, 2022 · 27 comments
Closed

Use the kbd role in the doc #34629

fchapoton opened this issue Oct 2, 2022 · 27 comments

Comments

@fchapoton
Copy link
Contributor

in particular to represent the Tab key as can be seen already near the end of

https://doc.sagemath.org/html/en/installation/launching.html

CC: @tscrim @kwankyu @kliem @slel

Component: documentation

Author: Frédéric Chapoton, ​John Palmieri

Branch/Commit: a0e1d3b

Reviewer: Kwankyu Lee

Issue created by migration from https://trac.sagemath.org/ticket/34629

@fchapoton fchapoton added this to the sage-9.8 milestone Oct 2, 2022
@fchapoton
Copy link
Contributor Author

Commit: 75fa0fd

@fchapoton
Copy link
Contributor Author

New commits:

75fa0fdusing the :kbd: role in the documentation (for Tab and other keys)

@fchapoton
Copy link
Contributor Author

Branch: u/chapoton/34629

@fchapoton

This comment has been minimized.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Oct 2, 2022

Changed commit from 75fa0fd to fbf3083

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Oct 2, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

fbf3083a few more

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Oct 2, 2022

Branch pushed to git repo; I updated commit sha1. New commits:

78f9a47again a few more :kbd:

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Oct 2, 2022

Changed commit from fbf3083 to 78f9a47

@jhpalmieri
Copy link
Member

comment:5

I've found some more. Can I push some changes?

@jhpalmieri
Copy link
Member

Changed branch from u/chapoton/34629 to u/jhpalmieri/34629

@fchapoton
Copy link
Contributor Author

Changed commit from 78f9a47 to 045adfb

@fchapoton
Copy link
Contributor Author

comment:7

sure, please do. Typo in your commit

:kbd:`Tab` key key

in src/doc/en/tutorial/interactive_shell.rst


New commits:

045adfbtrac 34629: more :kbd:

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Oct 3, 2022

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

3900ab7trac 34629: more :kbd:

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Oct 3, 2022

Changed commit from 045adfb to 3900ab7

@jhpalmieri
Copy link
Member

comment:9

Typo fixed, thank you for catching that.

@fchapoton
Copy link
Contributor Author

comment:10

oh, this breaks our rst linter, for instance

sage/databases/sql_db.py:1263:1: RST304 Unknown interpreted text role "kbd".

so we need to add this role to some list somewhere. But where ?

@fchapoton
Copy link
Contributor Author

comment:11

probably in src/tox.ini where there is a list "rst-roles"

@fchapoton
Copy link
Contributor Author

comment:12

let's see


New commits:

a0e1d3badding kbd to authorized roles

@fchapoton
Copy link
Contributor Author

Changed branch from u/jhpalmieri/34629 to u/chapoton/34629

@fchapoton
Copy link
Contributor Author

Changed commit from 3900ab7 to a0e1d3b

@fchapoton
Copy link
Contributor Author

comment:13

The linter is now happy. Let's wait for the rest of the reports.

@fchapoton
Copy link
Contributor Author

comment:14

good. John, please set to positive if you agree.

@kwankyu
Copy link
Collaborator

kwankyu commented Oct 4, 2022

comment:15

LGTM in code and in doc.

@kwankyu
Copy link
Collaborator

kwankyu commented Oct 4, 2022

Reviewer: Kwankyu Lee

@kwankyu
Copy link
Collaborator

kwankyu commented Oct 4, 2022

Changed author from Frédéric Chapoton to Frédéric Chapoton, ​John Palmieri

@kwankyu

This comment has been minimized.

@kwankyu kwankyu changed the title using the kbd role in the doc Use the kbd role in the doc Oct 4, 2022
@vbraun
Copy link
Member

vbraun commented Oct 16, 2022

Changed branch from u/chapoton/34629 to a0e1d3b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants