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.

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

Improves display of preferences list command #9292

Merged
merged 3 commits into from
Dec 4, 2023
Merged

Conversation

natemoo-re
Copy link
Member

@natemoo-re natemoo-re commented Dec 4, 2023

Changes

  • It was noted during docs review on Add astro preferences CLI reference docs#5512 that there's not a great way for users to understand what preferences are available to them.
  • This PR updates the astro preferences list command to display more information about the current preferences as well as what additional preferences can be set.

Before

Without preferences
CleanShot 2023-12-04 at 13 36 12@2x

With preferences
CleanShot 2023-12-04 at 13 36 28@2x

After

Without preferences
CleanShot 2023-12-04 at 13 29 20@2x

With preferences
CleanShot 2023-12-04 at 13 29 04@2x

Testing

Tested manually, no coverage of this CLI command

Docs

The lack of docs is kinda the whole point of the PR! Better to make this info available in the CLI than have a reference page that has to stay in sync with Astro.

Copy link

changeset-bot bot commented Dec 4, 2023

🦋 Changeset detected

Latest commit: 276130a

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Dec 4, 2023
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Looks great! And yes, now I don't have to maintain a current list 😅

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@natemoo-re natemoo-re merged commit 5428b3d into main Dec 4, 2023
4 checks passed
@natemoo-re natemoo-re deleted the fix/preferences-list branch December 4, 2023 19:56
This was referenced Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants