-
Notifications
You must be signed in to change notification settings - Fork 50
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
Move timeouts and rate-limiting to separate docs chapter #122
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple notes:
I agree that it should be "Contributing". I also like the idea of moving it up after Quickstart and before Authentication.
I'd like to reword line 22, something like:
For example, to enable a request timeout of 5 seconds:
or something like that, because right after the example you did a great job of explaining what values are supported. At a minimum, I would recommend adding a colon.
My 2 cents.. I agree with "Contributing". As for the configuration title, I was thinking as both as these are optional configurations, we could call it "Optional Configuration"? I would keep it after "Authentication" though as auth is one of the most common questions/issues/requests we've had. Other than thatm I agree with @prcutler's rewording too. Hope that helps! |
https://python3-discogs-client.readthedocs.io/en/docs_config_chapter/ have a look. Enabled the branch (hidden just with link). What do you think? Kept the position but renamed to optional. Reworded the "timeout sentence". |
Note sure what's up with the tests, maybe change |
03a5523
to
4b7a6c3
Compare
Thanks for the hint Anssi! Fixed! File name was intentionally just configuration.md instead of longer, but you're right, probably it could be confusion when quickly trying to find it by beginning later. Will fix that and merge! |
by using a specific Ubuntu version. Reason: actions/setup-python/issues/555
4b7a6c3
to
99a443c
Compare
optional_configuration.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 👍
What do you think?
Any better ideas for a chapter name? Advanced Configuration? Settings? Advanced Settings?
What I don't like is that it looks pretty similar to "Contribution" since that is right next to it. Maybe just another position in the menu would fix that?
Suggestions welcome.
Cheers!