Skip to content

Migrate docstrings to NumPy style#149

Open
AndrewSazonov wants to merge 10 commits intodevelopfrom
new-docstring-style
Open

Migrate docstrings to NumPy style#149
AndrewSazonov wants to merge 10 commits intodevelopfrom
new-docstring-style

Conversation

@AndrewSazonov
Copy link
Copy Markdown
Member

This PR applies the latest Copier template updates and converts all docstrings in the source tree from Google style to NumPy style. Tutorial for Magnetic nanoparticles is added to TOC.

@AndrewSazonov AndrewSazonov added the [scope] maintenance Code/tooling cleanup, no feature or bugfix (major.minor.PATCH) label Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (develop@92567d7). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #149   +/-   ##
==========================================
  Coverage           ?   97.84%           
==========================================
  Files              ?       38           
  Lines              ?     2599           
  Branches           ?      449           
==========================================
  Hits               ?     2543           
  Misses             ?       32           
  Partials           ?       24           
Flag Coverage Δ
integration 48.90% <ø> (?)
unittests 97.84% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@henrikjacobsenfys henrikjacobsenfys left a comment

Choose a reason for hiding this comment

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

A small nitpick, but otherwise looks good to me :)

energy_offset : Numeric | Parameter, default=0.0
An energy offset to apply to the energy values before convolution. By default, 0.0.
upsample_factor : Numeric | None, default=5
The factor by which to upsample the input data before convolution. Default is
Copy link
Copy Markdown
Member

@henrikjacobsenfys henrikjacobsenfys Apr 2, 2026

Choose a reason for hiding this comment

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

This and many other places has default in the type description, and I also had it in the text description (I thought I had gotten rid of those, but clearly not). But now it says "Default is 5. By default, 5".

I don't mind too much as it's all still work in progress, but it doesn't look great

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[scope] maintenance Code/tooling cleanup, no feature or bugfix (major.minor.PATCH)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants