Merge branch 'contributing-docstring-fix' into 'v3'
Fix example docstring example in CONTRIBUTING.md See merge request openflexure/openflexure-microscope-server!324
This commit is contained in:
commit
dd8c97e0b6
1 changed files with 1 additions and 2 deletions
|
|
@ -77,8 +77,7 @@ For function arguments, return values, and exceptions we use the following style
|
|||
|
||||
```python
|
||||
def a_function(arg1: str, arg2: int) -> tuple[float, int]:
|
||||
"""
|
||||
A one sentence summary, in imperative mood, ending with punctuation.
|
||||
"""A one sentence summary, in imperative mood, ending with punctuation.
|
||||
|
||||
More detail after a blank line. This could be a whole paragraph.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue