-
Notifications
You must be signed in to change notification settings - Fork 43
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
docs: Extend contribution parts with DoD hints #94
docs: Extend contribution parts with DoD hints #94
Conversation
Codecov Report
@@ Coverage Diff @@
## master #94 +/- ##
==========================================
+ Coverage 93.09% 94.70% +1.60%
==========================================
Files 69 68 -1
Lines 4955 4909 -46
==========================================
+ Hits 4613 4649 +36
+ Misses 342 260 -82
Continue to review full report at Codecov.
|
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.
Looks good!
In order to maintain clear and user-friendly project make sure, that your | ||
changes respect PEP8 standards. PEP8 is a guide that provides Python best | ||
practices (naming, indentation,...). |
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.
In order to maintain clear and user-friendly project make sure, that your | |
changes respect PEP8 standards. PEP8 is a guide that provides Python best | |
practices (naming, indentation,...). | |
PEP8 is the python naming convention and it also applies to our project. |
:)
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.
It's actually not just a naming convention, it also concerns white space, redundant syntax, indent, not sure I have to change this one
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.
To be exact PEP8 is just the python style guide for python code (:
Origin text is acutally ok..
If you want to improve
" PEP8 is the python style guide for python code that provides..... "
4458b4d
to
6d18679
Compare
6d18679
to
80eeb53
Compare
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.
see suggestions
some_int_list_param: List[int], some_imported_type_param: namedtuple | ||
) -> list: | ||
|
||
|
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.
To prevent circular dependencies
Edit: To see the usage of future.annotations :)
.. code:: python | |
from __future__ import annotations | |
from typing import TYPE_CHECKING | |
if TYPE_CHECKING: | |
from .fruits import Banana | |
class BananaJuiceMaker: | |
def __init__(self, banana: Banana) -> None: | |
self.banana = banana | |
@classmethod | |
def juice_factory(cls, fruit: Union[Banana, Kiwi]) -> BananaJuiceMaker | |
return cls(fruit) | |
... |
80eeb53
to
e965ea5
Compare
- pre-commit hook : | ||
hook scripts that lint the added code using | ||
flake8 and format it using black and isort (for | ||
installation see :ref:`getting_started`) |
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.
I think the reference is missing in getting_started.rst (.. _getting_started
)
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.
It does not work neither with one or the other implemetation, just will replace with no reference
e965ea5
to
66b0e76
Compare
No description provided.