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

[FEAT] Doxygen comments for code #32

Open
3 tasks
aburrell opened this issue Jan 11, 2021 · 0 comments
Open
3 tasks

[FEAT] Doxygen comments for code #32

aburrell opened this issue Jan 11, 2021 · 0 comments
Assignees
@aaronjridley
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
v0.0.1

Comments

@aburrell
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Some of the code features and attributes could use more explanation

Describe the solution you'd like
Although this is general and ongoing, I would specifically (for this issue) like to see:

  • descriptions of the existing classes
  • reasons behind different dimensions (nGeoAlts)
  • makefile flags

Describe alternatives you've considered
Not making a note of specific areas that I think need comments and leaving it to chance.

Additional context
Items noted for future improvement in PR #31
@aburrell aburrell added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 11, 2021
@aburrell aburrell added this to the v0.0.1 milestone Jan 11, 2021
@qalshidi qalshidi mentioned this issue May 4, 2021
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aaronjridley aaronjridley

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
v0.0.1
Development

No branches or pull requests
2 participants
@aaronjridley @aburrell