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 docstrings to variables #277

Merged
merged 3 commits into from
May 2, 2023
Merged

Conversation

willGraham01
Copy link
Collaborator

Context/Description

Adds docstrings to variables and classes that were currently lacking them, using the information @prmunro provided in #219.

Testing

Only changes are docstrings, and a quick Doxygen build locally confirms the docstrings are found.

@codecov
Copy link

codecov bot commented Apr 28, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (e8332c2) 48.09% compared to head (f64ce81) 48.09%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #277   +/-   ##
=======================================
  Coverage   48.09%   48.09%           
=======================================
  Files          63       63           
  Lines        7804     7804           
=======================================
  Hits         3753     3753           
  Misses       4051     4051           
Impacted Files Coverage Δ
tdms/include/arrays.h 26.75% <0.00%> (ø)
tdms/include/output_matrices/id_variables.h 0.00% <0.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@samcunliffe samcunliffe left a comment

Choose a reason for hiding this comment

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

🍉

@willGraham01
Copy link
Collaborator Author

CodeCov once again hates me too - is it looking at the correct basis?

@samcunliffe samcunliffe merged commit cd39b9b into main May 2, 2023
11 of 12 checks passed
@samcunliffe samcunliffe deleted the wgraham-variable_docstrings branch May 2, 2023 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Physical Meaning of variables
2 participants