Skip to content

Update developer documentation#267

Open
ia267 wants to merge 12 commits intoxcompact3d:mainfrom
ia267:247_update_contributor_docs
Open

Update developer documentation#267
ia267 wants to merge 12 commits intoxcompact3d:mainfrom
ia267:247_update_contributor_docs

Conversation

@ia267
Copy link
Collaborator

@ia267 ia267 commented Jan 29, 2026

  • Added comments to all the source files using FORD format (see https://forddocs.readthedocs.io/en/stable/) - this was done using GitHub Copilot with Claude Sonnet 4.5
  • The process was semi-automatic (the AI agent had missed some parts of the documentation, or some of it was incorrect). Most comments are not verified for correctness. When we are modifying some code we have to make sure that it is actually correct. For the code that I did look at, they were mostly correct (but for some parts of the code it had hallucinated and made up stuff)

For review I suggest looking at couple of source files that you're familiar with and check if the comments are OK (in terms of accuracy, verbosity).

Alternatively you could do the following:

  • install ford using pip install ford
  • go to the directory x3d2/docs and then run ford ford.md
  • Then open the the x3d2/docs/doc/index.html in a browser

Close #247

@ia267 ia267 self-assigned this Jan 29, 2026
@ia267 ia267 added the documentation Improvements or additions to documentation label Jan 29, 2026
@ia267 ia267 added this to the Developer documentation milestone Jan 29, 2026
@ia267 ia267 requested a review from kaanolgu January 29, 2026 19:11
Copy link
Collaborator

@kaanolgu kaanolgu left a comment

Choose a reason for hiding this comment

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

Initial check for poisson_fft and poisson_fft_cuda

@ia267 ia267 force-pushed the 247_update_contributor_docs branch from 3b6afdc to 57a0a33 Compare February 12, 2026 15:56
@ia267 ia267 requested a review from kaanolgu February 12, 2026 16:19
@kaanolgu
Copy link
Collaborator

LGTM! (If anything else pops up, we can always address it in a follow-up PR)

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve contributor documentation

2 participants

Comments