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

Expand ReSolve documentation #130

Merged
merged 5 commits into from
Dec 20, 2023
Merged

Expand ReSolve documentation #130

merged 5 commits into from
Dec 20, 2023

Conversation

pelesh
Copy link
Collaborator

@pelesh pelesh commented Dec 20, 2023

Add Doxygen comments to the code.

Copy link
Collaborator Author

@pelesh pelesh left a comment

Choose a reason for hiding this comment

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

This is ready to be merged. I left a few optional comments.

resolve/RandSketchingCountSketch.cpp Outdated Show resolved Hide resolved
resolve/RandSketchingCountSketch.cpp Outdated Show resolved Hide resolved
resolve/RandSketchingFWHT.cpp Outdated Show resolved Hide resolved
resolve/RandSketchingManager.cpp Outdated Show resolved Hide resolved
resolve/matrix/Sparse.cpp Show resolved Hide resolved
resolve/vector/Vector.cpp Outdated Show resolved Hide resolved
resolve/vector/Vector.cpp Outdated Show resolved Hide resolved
resolve/vector/Vector.cpp Outdated Show resolved Hide resolved
resolve/vector/Vector.cpp Outdated Show resolved Hide resolved
resolve/vector/Vector.cpp Show resolved Hide resolved
Copy link
Collaborator

@ryandanehy ryandanehy left a comment

Choose a reason for hiding this comment

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

On the doxygen landing page https://resolve.readthedocs.io/en/kasia-documentation/doxygen/html/index.html

There is a list at the bottom. Are these items suppose to link to something?

@pelesh
Copy link
Collaborator Author

pelesh commented Dec 20, 2023

On the doxygen landing page https://resolve.readthedocs.io/en/kasia-documentation/doxygen/html/index.html

There is a list at the bottom. Are these items suppose to link to something?

These are subtitles for separate sections describing ReSolve architecture. I think we can leave it as is for the alpha release, but will need to populate these subsections before 1.0.

@pelesh pelesh merged commit afefdd9 into develop Dec 20, 2023
9 checks passed
@pelesh pelesh deleted the kasia-documentation branch December 21, 2023 03:55
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.

3 participants