Skip to content

Comments

doc(cli): reorder sections and unify heading#10035

Merged
abn merged 2 commits intopython-poetry:mainfrom
abn:docs/reorder-commands
Jan 16, 2025
Merged

doc(cli): reorder sections and unify heading#10035
abn merged 2 commits intopython-poetry:mainfrom
abn:docs/reorder-commands

Conversation

@abn
Copy link
Member

@abn abn commented Jan 13, 2025 •
edited
Loading

This has been bugging me for a while now. This change attempts the following.

  1. Commands and sub-commands are ordered ascending alphabetically.
  2. All option sections use #### headings.

image

Summary by Sourcery

Documentation:

  • Reordered commands and sub-commands alphabetically. Standardized option section headings to ####.

@abn abn added area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes labels Jan 13, 2025
@abn abn requested a review from a team January 13, 2025 16:25
@sourcery-ai
Copy link

sourcery-ai bot commented Jan 13, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This PR reorders sections and unifies headings in the cli.md document to improve readability and consistency. Specifically, commands and sub-commands are now ordered alphabetically, and all option sections use #### headings.

Flow diagram showing the document structure changes

graph TD
    A[Original Document Structure] --> B[Reordered Document Structure]

    subgraph Before
    A1[Random Command Order] --> A2[Mixed Heading Levels]
    A2 --> A3[### Options]
    end

    subgraph After
    B1[Alphabetically Ordered Commands] --> B2[Consistent Heading Levels]
    B2 --> B3[#### Options]
    end

    style A1 fill:#ffcccc
    style A2 fill:#ffcccc
    style B1 fill:#ccffcc
    style B2 fill:#ccffcc
    style B3 fill:#ccffcc
Loading

File-Level Changes

Change Details Files
Reordered commands and sub-commands alphabetically.
  • Sections for commands like about, add, build, cache, check, config, env, export, help, init, install, list, lock, new, publish, remove, run, search, self, shell, show, source, sync, update, and version are reordered alphabetically.
  • Sub-commands under cache, env, and self are also reordered alphabetically within their respective sections.
 docs/cli.md
Unified headings for option sections.
  • All option sections now consistently use #### headings for improved visual structure and clarity. This replaces previous inconsistent heading levels, such as ## and other variations.
 docs/cli.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Jan 13, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @abn - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions
Copy link

github-actions bot commented Jan 13, 2025 •
edited
Loading

Deploy preview for website ready!

✅ Preview
https://website-9j4d1onkr-python-poetry.vercel.app

Built with commit eb88d58.
This pull request is being automatically deployed with vercel-action

@abn abn enabled auto-merge (rebase) January 13, 2025 16:31
@abn abn force-pushed the docs/reorder-commands branch from 57aa388 to 284ac5c Compare January 15, 2025 04:01
Secrus
Secrus previously requested changes Jan 15, 2025
View reviewed changes
@abn abn force-pushed the docs/reorder-commands branch from 284ac5c to d6eb108 Compare January 15, 2025 19:01
@abn abn requested a review from Secrus January 15, 2025 19:02
@abn abn dismissed Secrus’s stale review January 15, 2025 19:10

Review comments addressed.

@abn abn force-pushed the docs/reorder-commands branch from d6eb108 to eb88d58 Compare January 16, 2025 09:58
@abn abn merged commit 2e8e4e0 into python-poetry:main Jan 16, 2025
74 checks passed
@abn abn deleted the docs/reorder-commands branch January 16, 2025 10:47
@radoering radoering mentioned this pull request Feb 9, 2025
Merged
4 tasks
@github-actions
Copy link

github-actions bot commented Feb 16, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 16, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@Secrus Secrus Secrus approved these changes

Assignees

No one assigned

Labels

area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@abn @Secrus