Documentation #43

New Issue

muellerr · 2020-04-18T17:25:56+02:00

muellerr commented

2020-04-18 17:25:56 +02:00

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 referenced this issue

2020-04-18 17:26:49 +02:00

WIP: documentation related commits #22

muellerr commented

2020-04-22 19:11:08 +02:00

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

muellerr added the

Documentation

label 2020-04-22 19:11:13 +02:00

muellerr closed this issue

2020-07-03 16:43:08 +02:00

Sign in to join this conversation.