Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scrub error documentation section of command codes #1396

Closed
skliper opened this issue Apr 20, 2021 · 0 comments · Fixed by #1719 or #1701
Closed

Scrub error documentation section of command codes #1396

skliper opened this issue Apr 20, 2021 · 0 comments · Fixed by #1719 or #1701
Assignees
@jphickey
Labels
CFS-41 docs This change only affects documentation.
Milestone
Caelum

Comments

@skliper
Copy link
Contributor

skliper commented Apr 20, 2021

Is your feature request related to a problem? Please describe.
Error documentation section of command codes is not consistent/complete

Describe the solution you'd like
Scrub and update the error documentation for all command codes. Needs to detail error cases.

Describe alternatives you've considered
None

Additional context
Code review

Requester Info
Jacob Hageman - NASA/GSFC
@skliper skliper added this to the 7.0.0 milestone Apr 20, 2021
@skliper skliper added docs This change only affects documentation. and removed enhancement labels Apr 29, 2021
@jphickey jphickey mentioned this issue Jul 26, 2021
Open
jphickey added a commit to jphickey/cFE that referenced this issue Jul 28, 2021
@jphickey
Fix nasa#1396, scrub command documentation
1211954 
Update documentation for all command codes in CFE core apps, in
particular the error conditions, to confirm it matches the
actual implementation.

For common operations that apply to all commmands (length verification)
this is now put into the users guide as a general statement rather
than repeating the info in every command.
This was referenced Jul 28, 2021
Merged
Closed
astrogeco added a commit that referenced this issue Jul 28, 2021
@astrogeco
Merge pull request #1719 from jphickey/fix-1396-command-docs
1b0e610 
Fix #1396, scrub command documentation
@astrogeco astrogeco mentioned this issue Jul 28, 2021
Merged
paulober pushed a commit to paulober/cFE that referenced this issue Aug 1, 2021
@jphickey
Fix nasa#1396, scrub command documentation
e089306 
Update documentation for all command codes in CFE core apps, in
particular the error conditions, to confirm it matches the
actual implementation.

For common operations that apply to all commmands (length verification)
this is now put into the users guide as a general statement rather
than repeating the info in every command.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jphickey jphickey

Labels
CFS-41 docs This change only affects documentation.
Projects
None yet
Milestone
Caelum
2 participants
@jphickey @skliper