Import formatting - Githubissues

Breakthrough-Energy / docs

Documentation

https://breakthrough-energy.github.io/docs/

Creative Commons Attribution 4.0 International

13 stars 14 forks source link

Import formatting #13

Closed rouille closed 4 years ago

rouille commented 4 years ago

Purpose

Write the Import Formatting section.

Where to look.

check the Import Formatting section.
anchors for links have been defined.
use code snippet in the Pytest and Tox section
remove GenMWMax from the test since it is not anymore in our data

Time estimate

15 min

jenhagg commented 4 years ago

Wonder if it's possible to give a short TL;DR for users, something like this:

don't use wildcard imports
do use absolute imports
run isort via tox

Does this cover everything?

rouille commented 4 years ago

Wonder if it's possible to give a short TL;DR for users, something like this:
* don't use wildcard imports

* _do_ use absolute imports

* run isort via tox
Does this cover everything?

Yes. Should I place it at the beginning of the section?

jenhagg commented 4 years ago

Yes. Should I place it at the beginning of the section?

Sure, sounds good to me

rouille commented 4 years ago

@kasparm and @jon-hagg, I have created a new Markdown file that encloses the section. We now have a link to it in contribution_guidelines.md. What do you think?

jenhagg commented 4 years ago

Looks good to me!