Skip to content

fix: Conventions #436

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.

Sign up for GitHub

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

Jump to bottom
Merged
LecrisUT merged 2 commits into from
Mar 2, 2024
Merged

fix: Conventions #436

LecrisUT merged 2 commits into from
Mar 2, 2024

Conversation

@LecrisUT
Copy link
Collaborator

@LecrisUT LecrisUT commented Feb 15, 2024 •
edited
Loading

  • doc -> docs
  • Add include folder for easier distinction between exported and private headers
  • Move files out of root
    • What are your thoughts on Changelog.md? It can be moved to /docs, but should it?
    • RTD needs to have the configuration change, I will do it as the last step for this PR

@codecov
Copy link

codecov bot commented Feb 15, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.59%. Comparing base (7e7fe81) to head (9bee67a).

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop     #436   +/-   ##
========================================
  Coverage    83.59%   83.59%           
========================================
  Files           24       24           
  Lines         8118     8118           
  Branches      1686     1693    +7     
========================================
  Hits          6786     6786           
  Misses        1332     1332
Flag Coverage Δ
c_api 74.43% <ø> (ø)
fortran_api 56.16% <ø> (ø)
python_api 79.70% <ø> (ø)
unit_tests 13.47% <ø> (ø)

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.

@LecrisUT LecrisUT marked this pull request as ready for review February 28, 2024 17:56
@LecrisUT LecrisUT requested review from atztogo and lan496 February 28, 2024 17:56
atztogo
atztogo approved these changes Feb 28, 2024
View reviewed changes
Copy link
Collaborator

@atztogo atztogo left a comment

Choose a reason for hiding this comment

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

Thanks @LecrisUT. Just asking, but are there any possible surprises for users?

@LecrisUT
Copy link
Collaborator Author

LecrisUT commented Feb 29, 2024

Thanks @LecrisUT. Just asking, but are there any possible surprises for users?

Nope, there wouldn't be any surprises

@LecrisUT
Convention doc -> docs
a4ccc0e 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Convention include folder
f95aa83 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@lan496
Copy link
Member

lan496 commented Mar 2, 2024

What are your thoughts on Changelog.md?

I think there are no pros to change the current location.

@LecrisUT LecrisUT merged commit 9ab66b3 into spglib:develop Mar 2, 2024
@LecrisUT LecrisUT deleted the fix/conventions branch March 2, 2024 12:05
@LecrisUT LecrisUT linked an issue Mar 27, 2024 that may be closed by this pull request
Nitpick: Sphinx docs location #366
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@atztogo atztogo atztogo approved these changes

@lan496 lan496 lan496 approved these changes

Assignees

@lan496 lan496

Labels

None yet

Projects

Spglib developers' kanban
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Nitpick: Sphinx docs location

3 participants

@LecrisUT @lan496 @atztogo