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

Rename phasorinc, add {C,D}Collection documentation, and main()main.cpp #200

Merged
merged 15 commits into from
Dec 13, 2022

Conversation

samcunliffe
Copy link
Member

There was a hanging documentation and a renaming task from our last meeting with Peter.

I also include a few minor sanity fixes:

  • I moved main into main.cpp.
  • Fixed the broken <details> tags (or at least it's fixed with my local doxygen version).
  • Updated the version of doxygen (I hope).

Typo in the README instructions. And try to get the details tags
working.
Based on discussion with Peter from a few weeks ago.
<details>

Copy link
Member Author

Choose a reason for hiding this comment

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

On the deployed version we have...

Screenshot 2022-12-13 at 11 24 43

@samcunliffe samcunliffe added documentation Improvements or additions to documentation housekeeping Code cleanup labels Dec 13, 2022
Copy link
Collaborator

@willGraham01 willGraham01 left a comment

Choose a reason for hiding this comment

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

Looks good 👍

Although I noticed that the current README usage instructions are also somewhat out of date (they don't mention the -h, -m or -fd flags, for example).

Maybe we should look to update this file? Or we could hold off till hdf5 has replaced MATLAB.

doc/developers.md Show resolved Hide resolved
tdms/CMakeLists.txt Outdated Show resolved Hide resolved
tdms/src/main.cpp Show resolved Hide resolved
@samcunliffe
Copy link
Member Author

samcunliffe commented Dec 13, 2022

Although I noticed that the current README usage instructions are also somewhat out of date (they don't mention the -h, -m or -fd flags, for example).

Good point, let's fix that here too whilst I'm in a documentationey mood. (It's better to have the documentation change along with changes to the code. ... Implying the doc was there beforehand 😹 )

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@willGraham01 willGraham01 left a comment

Choose a reason for hiding this comment

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

Looks OK, although has the -fd option disappeared? It's no longer in the documentation you've written. If it's deliberate ignore my other comments.

It looks like the tdms_tests executable is failing to build too since the GLOB update - I can't see anything wrong with the CMakeLists file though, so maybe there's something in targets.cmake that needs updating?

tdms/src/argument_parser.cpp Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/utils.cpp
matlabio/matlabio.cpp
)
file(GLOB_RECURSE SOURCES "src/*.cpp")
Copy link
Member Author

Choose a reason for hiding this comment

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

Tests fail because I (stupidly) didn't check the tests target. And this regex also finds main.cpp so there's a clash between the catch2 main() and the tdms main().

README.md Outdated Show resolved Hide resolved
tdms/CMakeLists.txt Outdated Show resolved Hide resolved
@samcunliffe samcunliffe merged commit 063f4a1 into main Dec 13, 2022
@samcunliffe samcunliffe deleted the rename-phasorinc-and-add-doc branch December 13, 2022 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation housekeeping Code cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants