Skip to content

Commit 6114366

Browse files
Improve new contributing section
1 parent 90a5094 commit 6114366

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -314,37 +314,58 @@ that a link will remain valid, add a custom anchor to the section title:
314314
(note the space after the opening brace). You can then refer to it within
315315
another markdown file with `[Some section][permanent-anchor-to-some-section]`.
316316

317-
### Adding notes about new features or changes
317+
### Adding notes about new features, changes or deprecations
318318

319319
We use the admonition extension of
320320
[Mkdocs Material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)
321321
to create admonitions, also known as call-outs, that hold information
322-
about when a certain feature was added or changed and optionally
323-
some description of the change. We put the admonition directly
322+
about when a certain feature was added, changed or deprecated and optionally
323+
a description with more details. We put the admonition directly
324324
in a module's, a function's or class' docstring.
325325

326-
For a new feature, we use the following admonition:
326+
We use the following syntax:
327327

328328
```
329-
!!! tip "New in version <Version Number>"
329+
!!! tip "<Event Type> in version <Version Number>"
330+
331+
<Optional Description>
330332
```
331333

332-
For a change to an existing feature we use instead:
334+
The description is useful when the note is about a smaller change
335+
such as a parameter.
333336

334-
```
335-
!!! tip "Changed in version <Version Number>"
337+
- For a new feature, we use:
336338

337-
<Description>
338-
```
339+
```
340+
!!! tip "New in version <Version Number>"
341+
342+
<Optional Description>
343+
```
339344

340-
For example, for a change in version `1.2.3` that adds kwargs
341-
to a class' constructor we would write:
345+
- For a change to an existing feature we use:
342346

343-
```
344-
!!! tip "Changed in version 1.2.3"
347+
```
348+
!!! tip "Changed in version <Version Number>"
345349
346-
Added kwargs to the constructor.
347-
```
350+
<Optional Description>
351+
```
352+
353+
For example, for a change in version `1.2.3` that adds kwargs
354+
to a class' constructor we would write:
355+
356+
```
357+
!!! tip "Changed in version 1.2.3"
358+
359+
Added kwargs to the constructor.
360+
```
361+
362+
- For a deprecation we use:
363+
364+
```
365+
!!! tip "Deprecated in version <Version Number>"
366+
367+
<Optional Description>
368+
```
348369

349370
### Using bibliography
350371

0 commit comments

Comments
 (0)