fsfw/fsfw
11
3
Fork 6
Code Issues 32 Pull Requests 4 Releases 10 Wiki Activity

Documentation #43

New Issue
Closed
opened 2020-04-18 17:25:56 +02:00 by muellerr · 1 comment
muellerr commented 2020-04-18 17:25:56 +02:00
Owner
Copy Link

Some modules lack documentation, which makes it harder for new developers to understand which tool to use for what. An example are the serialization tools.

I wrote/updates some documentation for the Serialization tools as I learnt and used them.
I did that in general for FSFW code whenever I came across undocumented function. Sometimes, I also did some formatting so the column width is max. 80. This is really nice to have two code sections next to each other, even on a big screen(I don't have the luxury of two screens yet).

I will try to gather all documentation changes in pull request #22.

Label: Documentation

Some modules lack documentation, which makes it harder for new developers to understand which tool to use for what. An example are the serialization tools. I wrote/updates some documentation for the Serialization tools as I learnt and used them. I did that in general for FSFW code whenever I came across undocumented function. Sometimes, I also did some formatting so the column width is max. 80. This is really nice to have two code sections next to each other, even on a big screen(I don't have the luxury of two screens yet). I will try to gather all documentation changes in pull request #22. Label: Documentation
muellerr commented 2020-04-22 19:11:08 +02:00
Author
Owner
Copy Link

#22 closed, will try to put it in smaller pull requests.

#22 closed, will try to put it in smaller pull requests.
muellerr added the
Documentation
 label 2020-04-22 19:11:13 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
API Change
Changes the API, so Users need to adapted
Breaking API Change
Changes the API in a non backwards compatible way
bug
Something is not working
build
Issues related to the buildsystem, including CI
cosmetics
Small change most users won't notice
Documentation
Improvement of code documentation
duplicate
This issue or pull request already exists
feature
New feature
help wanted
Need some help
hotfix
Quick or important fix that is merged directly into master, causing a new revision
invalid
#worksforme
question
More information is needed
Refactor
Contains a refactoring of some code
Tests
Issues related to testing code
wontfix
This won't be fixed
No Label
Documentation
Milestone
No items
No Milestone
Assignees
Clear assignees
ahinkel dwoodward gaisser hanke jenkins_buildfix lrajer meierj mohr muellerr taheran tbaumgartl
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: fsfw/fsfw#43
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?