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

Improve commenting throughout CF v3.0 #18

Closed
jphickey opened this issue Nov 23, 2021 · 4 comments · Fixed by #294
Closed

Improve commenting throughout CF v3.0 #18

jphickey opened this issue Nov 23, 2021 · 4 comments · Fixed by #294
Assignees
@skliper
Labels
docs draco-rc4
Milestone
Draco

Comments

@jphickey
Copy link
Contributor

This issue was imported from the GSFC issue tracking system

Imported from: [GSFCCFS-1194] Improve commenting throughout CF v3.0
Originally submitted by: Timmons, Elizabeth J. (GSFC-5820) on Mon Jul 20 13:32:23 2020

Original Description:
CF v3.0 needs improved commenting throughout. Specifically:

  • file comments in every file describing the purpose of the file
  • explanations and limits for all configuration parameters
  • ensure that all comments are accurate
@jphickey
Copy link
Contributor Author

Imported comment by internal user on Mon Jul 27 18:51:30 2020

I've done what's on the list. Do you want me to look for places in the functions to add more comments?

@jphickey
Copy link
Contributor Author

Imported comment by internal user on Tue Jul 28 09:52:26 2020

No, as long as you've done what's on the list that should be fine.

@jphickey
Copy link
Contributor Author

Imported comment by internal user on Fri Sep 3 08:46:28 2021

This needs reassigned please.

@skliper
Copy link
Contributor

skliper commented Mar 24, 2022

Related to #206, although this ticket is more general.

@skliper skliper added the docs label Mar 24, 2022
@skliper skliper added this to the Draco milestone Jun 14, 2022
@skliper skliper self-assigned this Jun 17, 2022
skliper added a commit to skliper/CF that referenced this issue Jul 27, 2022
@skliper
Fix nasa#18, Spelling cleanup in comments and events
fac6e31
@skliper skliper mentioned this issue Jul 27, 2022
Merged
2 tasks
skliper added a commit to skliper/CF that referenced this issue Jul 27, 2022
@skliper
Fix nasa#18, Spelling cleanup in comments and events
a395ff5
dzbaker added a commit that referenced this issue Jul 28, 2022
@dzbaker
Merge pull request #294 from skliper/fix206-documentation_1
557c132 
Fix #18 #206 #287, Comment cleanup and spelling
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skliper skliper

Labels
docs draco-rc4
Projects
None yet
Milestone
Draco
Development

Successfully merging a pull request may close this issue.

Fix #18 #206 #287, Comment cleanup and spelling skliper/CF
3 participants
@dzbaker @jphickey @skliper