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

Print debug categories, add examples for fish --debug #7007

Merged
merged 3 commits into from
May 19, 2020

Conversation

charego
Copy link
Contributor

@charego charego commented May 15, 2020

Description

Personally I was most confused by the description of fish --debug-categories and needed to look in the code to figure out it supported comma-separated values in addition to globs. Hopefully this rewording and some examples makes it easier for the next person.

I also found it helpful to print out the enabled debug categories. Without this information it's hard to tell immediately that your --debug-categories value is working as expected.

Copy link
Member

@krobelus krobelus left a comment

Choose a reason for hiding this comment

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

This is a really useful, especially to have examples!

doc_src/cmds/fish.rst Outdated Show resolved Hide resolved
doc_src/cmds/fish.rst Outdated Show resolved Hide resolved
doc_src/cmds/fish.rst Outdated Show resolved Hide resolved
@krobelus
Copy link
Member

Seems good.

I guess that most users should never need to use the debug option, but this is probably the most obvious place to add examples to.

@charego
Copy link
Contributor Author

charego commented May 17, 2020

Since fish_indent does not support categories, I reverted its documentation.

https://fishshell.com/docs/3.0/commands.html#fish_indent

@krobelus krobelus merged commit b673f32 into fish-shell:master May 19, 2020
@krobelus
Copy link
Member

Thanks!

@krobelus krobelus added this to the fish 3.2.0 milestone May 19, 2020
@charego charego deleted the fish-debugging branch May 19, 2020 20:13
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants