-
Notifications
You must be signed in to change notification settings - Fork 76
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
API docs for user preferences #1259
API docs for user preferences #1259
Conversation
I feel like this shouldn't be a top level section of the Central API, but should be nested under the Accounts and Users section, probably after You could also mention this in the 2024.3 section of the changelog. There is already one bullet point there. |
I thought about that at the time but thought it'd be better to follow the URL scheme. But yeah, the rest of the documentation doesn't do that always either. Fixed in e6a236e!
What stopped me at the time was the Changelog subscript that says "Here major and breaking changes to the API are listed by version"; I didn't consider this API addition as major. Do you feel it's major? |
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.
I have a few more minor requests but you can make those changes and go ahead and merge!
Do you feel it's major?
I think so! I mean, it's a whole new set of endpoints... now that the doors of a few user preferences have been opened, folks (like the QA team) are already starting to ask for more!
Even if it's targeted at ourselves, it would be useful to note it. I can see myself glancing through the changelog to remind myself when user preferences were added to the API.
Towards #1211
I've hauled it through the sphinx circus to make sure it gets rendered.