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.

Sign up for GitHub

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

Jump to bottom

Wrap CLI options in description with backticks #544

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Wrap CLI options in description with backticks #544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/build/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,15 +262,15 @@ def main_parser() -> argparse.ArgumentParser:
'''
A simple, correct PEP 517 build frontend.

By default, a source distribution (sdist) is built from {srcdir}
By default, a source distribution (sdist) is built from ``{srcdir}``
and a binary distribution (wheel) is built from the sdist.
This is recommended as it will ensure the sdist can be used
to build wheels.

Pass -s/--sdist and/or -w/--wheel to build a specific distribution.
Pass ``-s/--sdist`` and/or ``-w/--wheel`` to build a specific distribution.
If you do this, the default behavior will be disabled, and all
artifacts will be built from {srcdir} (even if you combine
-w/--wheel with -s/--sdist, the wheel will be built from {srcdir}).
artifacts will be built from ``{srcdir}`` (even if you combine
``-w``/``--wheel`` with ``-s``/``--sdist``, the wheel will be built from ``{srcdir}``).
'''
).strip(),
' ',
Expand Down