Skip to content

Commit 34be221

Browse files
authored
[skip ci] Updated contrib guide
1 parent 13e3368 commit 34be221

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,10 @@ for formatting docstrings, specially from an example of `Google style with Pytho
293293
- [`.. versionchanged::`] directive for adding new arguments, changing internal behaviours, fixing bugs and
294294
- [`.. deprecated::`] directive for deprecations.
295295

296+
Examples: ``versionadded`` usage [link](https://github.com/pytorch/ignite/blob/52c69251dd9d97c32da1df0477ec3854e5702029/ignite/handlers/state_param_scheduler.py#L24), ``versionchanged`` usage [link](https://github.com/pytorch/ignite/blob/d2020e4e253ac1455a757c2db895c68ccfd2b958/ignite/metrics/metric.py#L281-L282)
297+
298+
299+
296300
Length of line inside docstrings block must be limited to 120 characters.
297301

298302
[`.. versionadded::`]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded

0 commit comments

Comments
 (0)