Skip to content

Update document for (spg_)get_spacegroup_type_from_symmetry#593

Merged
atztogo merged 2 commits intospglib:developfrom
atztogo:doc-update
Jun 22, 2025
Merged

Update document for (spg_)get_spacegroup_type_from_symmetry#593
atztogo merged 2 commits intospglib:developfrom
atztogo:doc-update

Conversation

@atztogo
Copy link
Copy Markdown
Collaborator

@atztogo atztogo commented Jun 21, 2025

@LecrisUT, I could not build document locally. Could you tell me what is the best way to check the doc build?

#584 revealed that the lattice parameter of (spg_)get_spacegroup_type_from_symmetry is necessary to transform symmetry operations in a reasonable form when the matrix representations of those operations were obtained with respect to oblique basis vectors. Following this, the documentation has been updated.

@codecov
Copy link
Copy Markdown

codecov bot commented Jun 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.48%. Comparing base (31279cc) to head (1fdb568).
⚠️ Report is 18 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #593   +/-   ##
========================================
  Coverage    74.48%   74.48%           
========================================
  Files           26       26           
  Lines         7888     7888           
  Branches      1637     1637           
========================================
  Hits          5875     5875           
  Misses        1534     1534           
  Partials       479      479           
Flag Coverage Δ
c_api 69.42% <ø> (ø)
fortran_api 52.91% <ø> (ø)
python_api 67.34% <ø> (ø)
unit_tests 11.69% <ø> (ø)

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.

@atztogo
Copy link
Copy Markdown
Collaborator Author

atztogo commented Jun 21, 2025

Sorry, I found docs/README.md and it worked.

@atztogo atztogo merged commit f255fca into spglib:develop Jun 22, 2025
49 checks passed
@atztogo atztogo deleted the doc-update branch June 22, 2025 06:32
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