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

Add "Style Guidelines" doc somewhere #1874

Open
cspotcode opened this issue Aug 10, 2023 · 4 comments
Open

Add "Style Guidelines" doc somewhere #1874

cspotcode opened this issue Aug 10, 2023 · 4 comments

Comments

@cspotcode
Copy link
Collaborator

Add contributing docs explaining conventions for:

code style
commit style
docstring style

Linking to stuff we can put in the guide:

#1871
#1789
https://discord.com/channels/458662222697070613/458662458198982676/1139202373445767378

Yes, rated G messages please. I get it, just want to keep as many people as possible feeling welcome.
nothing major, a quick non-judgemental(!) blurb about keeping everything in issues, PRs, commits, & code G-rated

@cspotcode cspotcode changed the title Style Guidelines Add "Style Guidelines" doc somewhere Aug 10, 2023
@cspotcode
Copy link
Collaborator Author

Another thing:

Style guidance for magic methods, based on how they emit in sphinx w/prettyspecialmethods.
Draw inspiration from python docs: https://docs.python.org/3/library/stdtypes.html#dict

list(d)
Return a list of all the keys used in the dictionary d.

@pushfoo
Copy link
Member

pushfoo commented Aug 27, 2023

Examples should be included in this as well:

  1. When to add examples
  2. Avoid recursive / complex data structures in beginner-oriented examples (Revert __future__ import in all examples #1888)
  3. The top-level docstring

@gran4
Copy link
Contributor

gran4 commented Sep 27, 2023

I feel like there is a lot of duplication in the draw commands with things like draw_lrtb_rectangle_filled vs draw_lrbt_rectangle_filled. It seems that the only difference is the order of the parameters

@pushfoo
Copy link
Member

pushfoo commented Sep 27, 2023

there is a lot of duplication in the draw commands with things like

Correct. That's why the lrtb variants of rectangle draw functions are deprecated/ See #1650 and the development branch version of the doc. It's why the lrtb variants still use AttributeError instead of the more correct ValueError at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants