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.

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

Add event, command code, command structure, and telemetry structure documentation #206

Closed
3 tasks done
skliper opened this issue Mar 22, 2022 · 3 comments · Fixed by #294
Closed
3 tasks done

Add event, command code, command structure, and telemetry structure documentation #206

skliper opened this issue Mar 22, 2022 · 3 comments · Fixed by #294
Assignees
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Mar 22, 2022

Checklist (Please check before submitting)

  • I reviewed the Contributing Guide.
  • I reviewed the CF README.md file to see if the feature is in the major future work.
  • I performed a cursory search to see if the feature request is relevant, not redundant, nor in conflict with other tickets.

Is your feature request related to a problem? Please describe.
Missing user's guide documentation.

Also some inlines in cf_utils.h missing documentation.

Describe the solution you'd like
Add descriptions.

Describe alternatives you've considered
None

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added the docs label Mar 22, 2022
@skliper skliper changed the title Add event documentation Add event, command code, command structure, and telemetry structure documentation Mar 22, 2022
@skliper skliper added this to the Draco milestone Mar 22, 2022
@astrogeco astrogeco added bug and removed enhancement labels May 11, 2022
@astrogeco
Copy link
Contributor

I'm calling this a "documentation bug"

@skliper
Copy link
Contributor Author

skliper commented May 11, 2022

I rely on the "bug" label to indicate FSW bugs when reporting in VDDs and communicating w/ stakeholders so I'd prefer not using the general "bug" flag for a documentation issue. Maybe "critical" or the fact it's also tagged with the Draco milestone could be enough to indicate we need to fix it this round?

@astrogeco
Copy link
Contributor

Makes sense, removed. I wish we had scoped labels like on gitlab so we could have something like bug::fsw, bug::unit-test, bug::docs

@astrogeco astrogeco removed the bug label May 11, 2022
@skliper skliper self-assigned this Jun 17, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 5, 2022
dzbaker added a commit that referenced this issue Jul 7, 2022
Fix #206, Fix #26, Document Event IDs and remove unused
dzbaker added a commit that referenced this issue Jul 8, 2022
Part #206, Fix #26, Document Event IDs and remove unused
skliper added a commit to skliper/CF that referenced this issue Jul 21, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 21, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 26, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 26, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 26, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 27, 2022
dzbaker added a commit that referenced this issue Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants