Skip to content

ADR0005: Decide on python code style guide - #1232

Merged
lukpueh merged 2 commits into
theupdateframework:developfrom
lukpueh:adr0005
Dec 4, 2020
Merged

ADR0005: Decide on python code style guide#1232
lukpueh merged 2 commits into
theupdateframework:developfrom
lukpueh:adr0005

Conversation

@lukpueh

@lukpuehlukpueh commented Dec 3, 2020

Copy link
Copy Markdown
Member

Fixes#1128

Description of the changes being introduced by the pull request:
Document why we chose to henceforth use the Google Python style guide with minimal refinements.

Please verify and check that the pull request fulfills the following
requirements:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

joshuagl
joshuagl approved these changes Dec 3, 2020
View reviewed changes

@joshuagljoshuagl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks good, thanks @lukpueh. I pointed out a couple of minor nits, but I'm OK with the ADR as is.

(Apologies for being nit-picky about English.)

Comment threaddocs/adr/0005-use-google-python-style-guide.md
Comment threaddocs/adr/0005-use-google-python-style-guide.md Outdated
@trishankatdatadog

trishankatdatadog commented Dec 4, 2020

Copy link
Copy Markdown
Contributor

Good idea. Could we also use pylint, flake8, and black?

@lukpueh

lukpueh commented Dec 4, 2020

Copy link
Copy Markdown
MemberAuthor

Thanks for the comments, you two! No need to apologize, @joshuagl, I do appreciate language corrections, and our style guide actually encourages them.

Lukas Puehringerand others added 2 commits December 4, 2020 10:39
Lukas Puehringer@joshuagl
ADR0005: Decide on python code style guide
b5252fe
Use Google style guide with refinements, because the Google style
guide is a comprehensive, well-established style guide that is
mostly based on PEP-8 and was accepted by everyone on the TUF team.
There is no need to replicate these recommendations. However, we do
provide a very slim document with additional refinements, in order
to emphasize on items the we consider especially important, want to
be handled differently, or in one specific way, where the Google
guide would allow multiple.
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Co-authored-by: Joshua Lock <jlock@vmware.com>
Lukas Puehringer
Add style guide usage instructions to ADR0005
2385ebe
Similar instructions are in the style guide preamble, but we repeat
it here for emphasis.
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
@lukpueh

lukpueh commented Dec 4, 2020

Copy link
Copy Markdown
MemberAuthor

@joshuagl, I squashed your suggestions into my commit. @trishankatdatadog, I added another commit to mention linters and formatters and general style guide usage/transition instructions. Would either of you mind taking another look? Thanks!

trishankatdatadog
trishankatdatadog approved these changes Dec 4, 2020
View reviewed changes

@trishankatdatadogtrishankatdatadog left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💯

@trishankatdatadog

trishankatdatadog commented Dec 4, 2020

Copy link
Copy Markdown
Contributor

Hmm, I do have some reservations regarding hanging vs aligned indents in function arguments, but whatever, I can live with it.

@lukpueh

lukpueh commented Dec 4, 2020

Copy link
Copy Markdown
MemberAuthor

Hmm, I do have some reservations regarding hanging vs aligned indents in function arguments, but whatever, I can live with it.

What do you mean? Our new guide specifically favors aligned indent, which is what you seemed very passionate above.

@trishankatdatadog

trishankatdatadog commented Dec 4, 2020

Copy link
Copy Markdown
Contributor

What do you mean? Our new guide specifically favors aligned indent, which is what you seemed very passionate above.

My bad, I missed the tweak to the Google guide. Keep calm and carry on 💯 💯

@lukpueh
lukpueh merged commit 771592a into theupdateframework:developDec 4, 2020
sechkova added a commit to sechkova/tuf that referenced this pull request Feb 17, 2021
@sechkova
Apply the new code style to fetcher docstrings
e77cbd0
Ensure that the newly added files' docstrings adhere to the
recently adopted code style guideline (theupdateframework#1232).
Small code style improvements in comments and imports.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
sechkova added a commit to sechkova/tuf that referenced this pull request Feb 23, 2021
@sechkova
Apply the new code style to fetcher docstrings
4ab26ca
Ensure that the newly added files' docstrings adhere to the
recently adopted code style guideline (theupdateframework#1232).
Small code style improvements in comments and imports.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
sechkova added a commit to sechkova/tuf that referenced this pull request Feb 24, 2021
@sechkova
Apply the new code style to fetcher docstrings
93c6573
Ensure that the newly added files' docstrings adhere to the
recently adopted code style guideline (theupdateframework#1232).
Small code style improvements in comments and imports.
Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joshuagljoshuagljoshuagl approved these changes
+1 more reviewer
@trishankatdatadogtrishankatdatadogtrishankatdatadog approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Decide on style guideline

3 participants

@lukpueh@trishankatdatadog@joshuagl