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

Closes #173: Add Python Guidelines #177

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/coding/python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Python Guidelines
...

## Sections

- [Python Guidelines](#python-guidelines)
- [Sections](#sections)
- [Guidelines](#guidelines)
- [Pythonic](#pythonic)
- [Comprehensions](#comprehensions)

# Guidelines

## Pythonic

...

### Comprehensions
Favor list comprehensions over `.map`
```python
[
index
for index
in range(5)
]
```

## Importing Modules
Favor using using module notation (?) over import functions directly. Importing functions directly generally reduces readability, as it is not immediately apparent that the function is being imported.

Avoid
```python
from top.utils import do_thing

do_thing()
```

Favor
```python
from top import utils

utils.do_thing()
```
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Coding Guidelines
================
* [C#]({{ site.baseurl }}{% link coding/csharp.md %})
* [JavaScript]({{ site.baseurl }}{% link coding/javascript.md %})
* [Python]({{ site.baseurl }}{% link coding/python.md %})

Analyzers
=========
Expand Down