Decide for monospaced text syntax in RST files
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the repository's RST documentation and the cited Docutils inline-markup reference. Done means the project has a documented, consistent choice between interpreted text, inline literals, and Sphinx code roles, including whether Sphinx-specific behavior is intended.
Written by the indexing model from the issue text.
Description
There are different ways to get monospaced font in docs:
:code:`stuff``stuff```stuff``
According to the some docs
`stuff`= interpreted text``stuff``= inline literal
Usually when I want monospaced text in rst I go for ``stuff``. Is :code:`stuff` going to add some additional functionality/highlighting?
Is :code:`stuff` part of the rst syntax or is it specifi to Sphinx?
Originally posted by @Stannislav in https://github.com/BlueBrain/Atlas-Download-Tools/pull/56#discussion_r691301335
- Dominant language
- Python
- Stars
- 17
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from BlueBrain/Atlas-Download-Tools
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Some RMA queries never return all resultsMay be free again @Stannislav claimed this 1754 days ago, and no pull request is open. Open
BlueBrain/Atlas-Download-Tools#98 · 1 assignee ·
-
Add the "downloads faithful dataset" CLI commandMay be free again @Stannislav claimed this 1789 days ago, and no pull request is open. Open
BlueBrain/Atlas-Download-Tools#95 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
BlueBrain/Atlas-Download-Tools#93 · 1 reaction ·
All issues in BlueBrain/Atlas-Download-Tools
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
instance instance add
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
searxng/searx-instances#941 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
FluidNumerics/fluid-walk-blocker#89 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day