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

Docs issues #4308

Closed
SUPERCILEX opened this issue Sep 30, 2022 · 3 comments
Closed

Docs issues #4308

SUPERCILEX opened this issue Sep 30, 2022 · 3 comments

Comments

@SUPERCILEX
Copy link
Contributor

@epage
Copy link
Member

epage commented Sep 30, 2022

Help fiddlings like #1127 (comment) should be in the cookbook.

I feel like knowing what and how we want to cover it might take some more exploring. Could you create a separate issue. Generally, rollup issues like this are unhelpful and its better create dedicated issues but I went ahead and took care of the rest of the items in #4309

An example of the old help template should be in the cookbook.

Good idea. Instead of the cookbook though, I've put it in the docs for Command::help_template

The changelog doesn't say that errors were moved to error module

Huh. looks like I missed some deprecation attributes in v3 which we were relying on for some of these changes.

The crate_authors link here is broken

Thanks. We were relying on intra-doc links to keep things up-to-date but there were a couple of direct links still left

There's also no explanation of where this goes now that it isn't in the default template

Added a note about it

As far as I can tell, adding the color feature doesn't do anything anymore

As you can see, the color feature does still do stuff though help is more using other terminal styling than color but we generally mean all terminal styling with "color". #4132 has more discussion on the switch from the colors in --help

A bunch of methods

Thanks! Bad copy/paste since we first created these methods.

@epage
Copy link
Member

epage commented Sep 30, 2022

As #4309 is merged and the remaining item needs its own issue, I'm going to go ahead and close this out.

@epage epage closed this as completed Sep 30, 2022
@SUPERCILEX
Copy link
Contributor Author

Thanks for the fixes and color info, TIL.

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

No branches or pull requests

2 participants