Skip to content

Documentation core folder#264

Closed
Christian48596 wants to merge 19 commits into
MRChemSoft:masterfrom
Christian48596:documentation
Closed

Documentation core folder#264
Christian48596 wants to merge 19 commits into
MRChemSoft:masterfrom
Christian48596:documentation

Conversation

@Christian48596

Copy link
Copy Markdown

Done all documentation inside the folder 'core'

@ilfreddy

Copy link
Copy Markdown
Contributor

Thanks for the documentation work!
A couple of comments:

  1. a good portion of it seems to be not in doxygen format. Do you think you can make it doxygen-friendly?
  2. we have had a discussion lately on Zulip on whether documentation should go in the header files. We have not reached a consensus yet. So I would like to wait with this merge until that is decided.

@ilfreddy

Copy link
Copy Markdown
Contributor

Additional comments:

  1. the documentation builds fails which is maybe defeats the point of a documentation PR? 😉
  2. Conflicts must be solved

@Christian48596

Copy link
Copy Markdown
Author

I have solved the conflicts now looking for the compilation

@Christian48596

Copy link
Copy Markdown
Author

Now fixing the conflicts it is doxygen compatible

@Christian48596

Copy link
Copy Markdown
Author

All checks passed!

@ilfreddy

Copy link
Copy Markdown
Contributor

I think this could be an excellent starting point for a "docathon" where we go through this autogenerated documentation and make it more human-readable.

@moorberry moorberry mentioned this pull request Nov 6, 2025
@ilfreddy

Copy link
Copy Markdown
Contributor

Superseded by #265

@ilfreddy ilfreddy closed this Nov 13, 2025
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.

2 participants