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
Docs should use monospace font rather than italics for command syntaxes and help strings #62
Comments
This seems to be an issue with Sphinx as it uses < cite> and not < code>. I will speak about this in IRC as we can change the style from |
as I said, semantic. From the spec: "The cite element represents the cited title of a work; for example, the title of a book mentioned within the main text flow of a document." |
It's understandable from the above description why it is using < cite>. We wouldn't be going too far of it's definition by using it. |
I'm not sure how you got to that conclusion :/ is not for quotes per the standard, it's explicitly for the cited title of a work. Example: <p>The <cite>HTML Living Standard</cite> describes how to use HTML elements correctly.</p>
Why's it matter, you might ask? We can just style it with CSS and nobody will care! The meaning of the tag is important for accessibility - people using screenreaders and other assistive technologies. These sorts of software might decide to treat citations differently. Search engines might decide to treat the content inside the tags as references to other works. |
Eh, I will try get this done ASAP. |
The thing is - Sphinx has these cool things called code-blocks... the issue is it kind of requires a language. My guess would be 'bash' if it is supported. |
Doc seems to say you can use |
Well there we go :D |
Will fix tomorrow - going to sleep soon |
bendem to the rescue! |
Any updates on this one @jamierocks? |
@lol768 I will start working on this now :D |
Great! |
@jamierocks is this fixed? Can this be closed? |
OK, it seems like the solution would be to use |
for example: https://docs.korobi.io/channel/commands/removing.html
Usage: .<delcmd|unsetcmd> [-i ]
Should be:
Usage:
.<delcmd|unsetcmd> [-i <index>] <name>
And
so to remove the first value of the hit command you could use .delcmd -i 0 hit.
Could similarily become:
so to remove the first value of the hit command you could use
.delcmd -i 0 hit
.The text was updated successfully, but these errors were encountered: