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

Fix #760, Expand cmake documentation #2068

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

astrogeco
Copy link
Contributor

Describe the contribution

Expands cmake documentation

Testing performed
Documentation-only, just proofreading

Expected behavior changes
None

System(s) tested on
n/a

Additional context
none

Third party code
none

Contributor Info - All information REQUIRED for consideration of pull request
Gerardo E. Cruz-Ortiz, NASA
Elizabeth Timmons (@ejtimmon), NASA

Copy link
Contributor

@skliper skliper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend we avoid duplication of implementation information in the README. If instead the README referenced where things are documented or implemented there's less chance of things getting out of sync. Single source of truth preferred.

Co-authored-by: Elizabeth Timmons <ejtimmon@users.noreply@github.com>
@astrogeco
Copy link
Contributor Author

astrogeco commented Mar 22, 2022

I recommend we avoid duplication of implementation information in the README. If instead the README referenced where things are documented or implemented there's less chance of things getting out of sync. Single source of truth preferred.

agreed, this was an initial dump of the internal docs, I'll trim and link where there's duplication but parts of what is in this change aren't easy to find in other places

@skliper
Copy link
Contributor

skliper commented Mar 22, 2022

agreed, this was an initial dump of the internal docs, I'll trim and link where there's duplication but parts of what is in this change aren't easy to find in other places

Understood, which is why I think the README is helpful as a reference to all that "internal" documentation. Much of it is in various sample_defs or cmake implementation files. The closer the documentation is to the implementation the more likely it is kept up to date :)

@astrogeco astrogeco marked this pull request as draft March 22, 2022 17:36
@dzbaker dzbaker self-assigned this Sep 8, 2022
@dzbaker dzbaker added the CCB:Ignore Pull Request can be ignored. Will be re-examined at by next CCB. label Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Ignore Pull Request can be ignored. Will be re-examined at by next CCB.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants