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

Remove non-existent command from docs #368

Merged
merged 2 commits into from
Sep 8, 2024

Conversation

SVendittelli
Copy link
Contributor

Description

The docs reference the slumber show dir command which does not exist.
The similar slumber show paths command provides the required information.

Known Risks

None, this is a documentation only change.

QA

Ran oranda dev and observed the corrected docs.

Checklist

  • Have you read CONTRIBUTING.md already?
  • Did you update CHANGELOG.md?
    • Only user-facing changes belong in the changelog. Internal changes such as refactors should only be included if they'll impact users, e.g. via performance improvement.
  • Did you remove all TODOs?
    • If there are unresolved issues, please open a follow-on issue and link to it in a comment so future work can be tracked

The docs reference the `slumber show dir` command which does not exist.
The similar `slumber show paths` command provides the required
information.
Copy link
Owner

@LucasPickering LucasPickering left a comment

Choose a reason for hiding this comment

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

Nice catch, thanks for fixing this. I changed this command around a while ago and I guess I missed this part of the docs.

Copy link
Owner

@LucasPickering LucasPickering left a comment

Choose a reason for hiding this comment

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

Actually there are a couple tweaks I'd like to see, thanks

CHANGELOG.md Show resolved Hide resolved
docs/src/api/configuration/index.md Outdated Show resolved Hide resolved
Following the suggestions from the code review

Co-authored-by: Lucas Pickering <[email protected]>
@SVendittelli
Copy link
Contributor Author

I agree with your tweaks @LucasPickering, I have applied them 👍

@LucasPickering LucasPickering enabled auto-merge (squash) September 8, 2024 12:47
@LucasPickering LucasPickering merged commit 8bcafbe into LucasPickering:master Sep 8, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants