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

Duplicated documentation in unit-tests is out of date and doesn't add anything #947

Open
skliper opened this issue Apr 7, 2021 · 0 comments
Open

Duplicated documentation in unit-tests is out of date and doesn't add anything #947

skliper opened this issue Apr 7, 2021 · 0 comments
Labels
unit-test Tickets related to the OSAL unit testing (functional and/or coverage)

Comments

@skliper
Copy link
Contributor

skliper commented Apr 7, 2021

Is your feature request related to a problem? Please describe.
Tests in the unit-tests directory repeat API documentation, leading to possible inconsistencies.

Example - OS_create was removed, this actually tests OS_OpenCreate

osal/src/unit-tests/osfile-test/ut_osfile_fileio_test.c

Line 139 in 65c584f

** Syntax: int32 OS_creat(const char *path, int32 access)

Describe the solution you'd like
Remove duplicated documentation

Describe alternatives you've considered
None

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC
@skliper skliper added the unit-test Tickets related to the OSAL unit testing (functional and/or coverage) label Apr 7, 2021
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
@astrogeco
Merge pull request nasa#947 from skliper/fix928-route-direct-module
12f2ff1 
Fix nasa#928 and nasa#929 - Modularize software bus routing, add msg map hash
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
unit-test Tickets related to the OSAL unit testing (functional and/or coverage)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@skliper