Skip to content

Fix command line flag formatting in documentation#3035

Merged
aowen-uwmad merged 4 commits into
mainfrom
copilot/fix-additional-flags-formatting
Jan 27, 2026
Merged

Fix command line flag formatting in documentation#3035
aowen-uwmad merged 4 commits into
mainfrom
copilot/fix-additional-flags-formatting

Conversation

Copilot AI commented Jan 27, 2026

Copy link
Copy Markdown
Contributor

Double hyphens in command line flags were being rendered as emdashes in documentation (e.g., —help instead of --help).

Changes

Wrapped all command line flag names in inline code blocks across documentation to prevent markdown auto-formatting from converting -- to :

  • Client docs (client/page.mdx): 13 flags in "Additional Flags" section
  • Origin docs (origin/page.mdx): 8 flags in "Additional Command Line Arguments" section
  • Cache docs (cache/page.mdx): 5 flags in "Additional arguments" section

Example

-* **-h or --help**: Takes no argument and can be used with any Pelican sub command
+* **`-h` or `--help`**: Takes no argument and can be used with any Pelican sub command

This matches the existing pattern used in other documentation pages (e.g., generating-tokens/page.mdx).


Also fixed typo in cache docs: "output the the console" → "output to the console"

Original prompt

This section details on the original issue you should resolve

<issue_title>Fix formatting of "additional flags" in docs page</issue_title>
<issue_description>This is specifically referring to the Command Line Client Additional Flags section of the docs website.

Looks like some sort of autoformatting has turned the double hyphens (--) into emdashes (). For example,

-h or —help

when it should be

-h or --help

At first glance, fix would be to either

  1. Format as inline code blocks
  2. Disable autoformatting that converts double hyphens into emdashes.

Anyone can do (1), but for (2) will probably need to consult Cannon.</issue_description>

<agent_instructions>Please address this - only in the documentation</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: turetske <498529+turetske@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix formatting of additional flags in documentation Fix flag formatting in client docs to prevent emdash conversion Jan 27, 2026
Copilot AI requested a review from turetske January 27, 2026 19:31
Copilot AI and others added 2 commits January 27, 2026 19:33
Co-authored-by: turetske <498529+turetske@users.noreply.github.com>
Co-authored-by: turetske <498529+turetske@users.noreply.github.com>
Copilot AI changed the title Fix flag formatting in client docs to prevent emdash conversion Fix command line flag formatting in documentation Jan 27, 2026
@turetske turetske added the documentation Improvements or additions to documentation label Jan 27, 2026

@turetske turetske left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple and correct. Caught a typo as well.

@turetske turetske requested a review from aowen-uwmad January 27, 2026 19:43
@turetske turetske marked this pull request as ready for review January 27, 2026 19:43

@aowen-uwmad aowen-uwmad left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looked good to me in the local preview.

@aowen-uwmad aowen-uwmad merged commit 4cca8b0 into main Jan 27, 2026
30 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix formatting of "additional flags" in docs page

3 participants