-
Couldn't load subscription status.
- Fork 105
Modifed Coding-style-guide.md #474
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
Open
Helper2020
wants to merge
2
commits into
oppia:develop
Choose a base branch
from
Helper2020:black-formatter-doc
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,25 +18,33 @@ If you use [Sublime Text](http://www.sublimetext.com/), consider installing the | |
|
|
||
|
|
||
| ## Python | ||
|
|
||
| #### Black | ||
| Oppia uses [Black](https://black.readthedocs.io/en/stable/) as the standard Python code formatter. | ||
| Black enforces a consistent, opinionated style automatically and is run as a pre-commit hook. | ||
|
|
||
| - **Automatic formatting:** Black runs every time you make a commit to ensure consistent code style. | ||
| - **Manual formatting:** You can format a specific file manually using: | ||
| ```bash | ||
| black /home/dev/opensource/oppia/core/controllers/android.py | ||
|
|
||
|
|
||
| - Consider using a frozenset or tuple to a list, if the data structure is not meant to be subsequently modified. This applies especially to constants. | ||
| - If you need to raise an Exception, just do `raise Exception` -- no need to define custom exceptions. We tend to use exceptions fairly sparingly, though. | ||
| - Otherwise, please follow the [Google Python style guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md). In particular: | ||
| - There should be two empty lines before any top-level class or function definition. | ||
| - It's OK for the initial documentation string to be more than one line long. | ||
| - Prefer string interpolation over concatenation -- e.g. prefer: `'My string %s' % varname` to `'My string ' + varname`. | ||
| - When indenting from an open parenthesis ('('), prefer indenting by 4 rather than indenting from the position of the parenthesis. e.g., prefer: | ||
|
|
||
| ``` | ||
| my_function_with_a_really_long_name( | ||
| 'abc', 'def', None) | ||
| ``` | ||
|
|
||
| over | ||
|
|
||
| ``` | ||
| my_function_with_a_really_long_name('abc', | ||
| 'def', | ||
| None) | ||
| - **Indentation inside parentheses:** | ||
| Let [Black](https://black.readthedocs.io/en/stable/) handle indentation and line breaks automatically. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Have the Black hyperlink link to the section of this wiki page that discusses Black, instead. |
||
| Do **not** manually align to the opening parenthesis or indent by a fixed number of spaces. | ||
| For example, Black will format code like this: | ||
| ```python | ||
| my_function_with_a_really_long_name( | ||
| "abc", | ||
| "def", | ||
| None, | ||
| ) | ||
| ``` | ||
| - Docstrings should start with """ and end with """. The content of each docstring should be left-aligned. For example: | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Please move the section that talks about Black (basically, all the new stuff) just above the section that talks about Prettier, and give it the same level of heading. We should be consistent in how we describe the formatters.