Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
swh-docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Vincent Sellier
swh-docs
Commits
23bbd2e4
Commit
23bbd2e4
authored
4 years ago
by
vlorentz
Browse files
Options
Downloads
Patches
Plain Diff
Fix various warnings
parent
74a45f0b
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/architecture/index.rst
+2
-2
2 additions, 2 deletions
docs/architecture/index.rst
docs/contributing/python-style-guide.rst
+12
-6
12 additions, 6 deletions
docs/contributing/python-style-guide.rst
with
14 additions
and
8 deletions
docs/architecture/index.rst
+
2
−
2
View file @
23bbd2e4
...
...
@@ -7,5 +7,5 @@ Architecture
:titlesonly:
:hidden:
architecture
mirror
../
architecture
../
mirror
This diff is collapsed.
Click to expand it.
docs/contributing/python-style-guide.rst
+
12
−
6
View file @
23bbd2e4
...
...
@@ -39,13 +39,19 @@ Tests
+++++
* use ``pytest`` as test runner
* put ``tests/`` dir down deep in the module hierarchy, near to the code being tested
* naming conventions:
** ``tests/test_mymodule.py``
** ``class TestMyEntity(unittest.TestCase)``
** ``def behavior(self):``
*** do *not* prepend ``test_`` to all test methods;
use nose's ``@istest`` decorator instead
* ``tests/test_mymodule.py``
* ``class TestMyEntity(unittest.TestCase)``
* ``def behavior(self):``
* do *not* prepend ``test_`` to all test methods;
use nose's ``@istest`` decorator instead
Classes
+++++++
...
...
@@ -54,7 +60,7 @@ Classes
`inherit from 'object' explicitly <http://google.github.io/styleguide/pyguide.html?showone=Classes#Classes>`_
Docstrings
---------
---------
-
* docstrings should produce a nice API documentation when run through
`Sphinx <http://www.sphinx-doc.org/en/stable/>`_, in particular:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment