Clarify when to mark up numeric literals

Open
#1,312 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with the devguide documentation markup section linked in the issue and compare its wording with the referenced PR discussions. Update the guidance with clear rules and good/bad examples for numeric literals, with completion shown by an unambiguous recommendation that resolves the cited inconsistency.

Written by the indexing model from the issue text.

Description

needs: decision topic-documentation

The current devguide recommendations reads:

backquotes: ``text`` for code samples, variables, and literals.

Earlier, I've been corrected to use double backticks when marking up literals. Example PR remark:

Recently, I've seen other styles enforced:

Perhaps we need a clarification, possibly with good/bad examples?

Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/devguide

All issues in python/devguide

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.