Update docs with YOLOv8 banner (#160)
Co-authored-by: Paula Derrenger <107626595+pderrenger@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
parent
fdf294e4e8
commit
96fbf9ce58
12 changed files with 252 additions and 41 deletions
|
|
@ -56,13 +56,13 @@ To allow your work to be integrated as seamlessly as possible, we advise you to:
|
|||
|
||||
- ✅ Reduce changes to the absolute **minimum** required for your bug fix or feature addition. _"It is not daily increase
|
||||
but daily decrease, hack away the unessential. The closer to the source, the less wastage there is."_ — Bruce Lee
|
||||
|
||||
|
||||
### Docstrings
|
||||
|
||||
Not all functions or classes require docstrings but when they do, we follow [google-stlye docstrings format](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). Here is an example:
|
||||
|
||||
```python
|
||||
'''
|
||||
"""
|
||||
What the function does - performs nms on given detection predictions
|
||||
|
||||
Args:
|
||||
|
|
@ -74,7 +74,7 @@ Not all functions or classes require docstrings but when they do, we follow [goo
|
|||
|
||||
Raises:
|
||||
Exception Class: When and why this exception can be raised by the function.
|
||||
'''
|
||||
"""
|
||||
```
|
||||
|
||||
## Submitting a Bug Report 🐛
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue