File: documentation.md

package info (click to toggle)
python-crc 7.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 468 kB
  • sloc: python: 1,488; makefile: 5
file content (41 lines) | stat: -rw-r--r-- 872 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
---
name: 📚 Documentation
about: Add/Improve Documentation
title: 📚 <Insert Title>
labels: documentation
assignees: ''

---

# Summary
<!---
A short summary on what of what needs to be documented or updated.
--->

# Details
<!---
A detailed description about what kind of documentation should be added and/or updated and why.
--->

## Background & Context
<!---
Why should this documentation be added/updated?

E.g.: Users are struggling to use this API and have repeatedly asked for some example code.
--->

## References
<!---
Further references to e.g. other information resources like links to specification(s), api docs etc.
--->

# Task(s)
<!---
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.

e.g.:
- [ ] Update documentation of XYZ
- [ ] Bump version number
- [ ] Update changelog
- [ ] ...
--->