Skip to content

📝 Documenation fix related to bdl_input_iterator #691

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
merged 3 commits into from
Mar 13, 2025
Merged

📝 Documenation fix related to bdl_input_iterator #691

merged 3 commits into from
Mar 13, 2025

Conversation

marcelwa
Copy link
Collaborator

@marcelwa marcelwa commented Mar 13, 2025 •
edited
Loading

Description

RST documentation for mnt.pyfiction.input_bdl_configuration and mnt.pyfiction.bdl_input_iterator_params was missing. Additionally, the enumeration order in the docstring of fiction::input_bdl_configuration was confusing.

This PR fixes both issues.

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have added a changelog entry.
  • I have created/adjusted the Python bindings for any new or updated functionality.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

@marcelwa marcelwa added bug Something isn't working documentation Documentation is added or needed labels Mar 13, 2025
@marcelwa marcelwa requested review from Drewniok and Copilot March 13, 2025 11:20
@marcelwa marcelwa self-assigned this Mar 13, 2025
Copilot
Copilot AI reviewed Mar 13, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

@github-actions GitHub Actions
Copy link
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@codecov Codecov
Copy link

codecov bot commented Mar 13, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.36%. Comparing base (15b53ec) to head (51b0dbd).
Report is 71 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #691   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files         254      254           
  Lines       41399    41399           
  Branches     1878     1878           
=======================================
+ Hits        40722    40724    +2     
+ Misses        677      675    -2
Files with missing lines Coverage Δ
...ude/fiction/algorithms/iter/bdl_input_iterator.hpp 99.06% <ø> (ø)

... and 2 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 15b53ec...51b0dbd. Read the comment docs.

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

Drewniok
Drewniok approved these changes Mar 13, 2025
View reviewed changes
Copy link
Collaborator

@Drewniok Drewniok left a comment

Choose a reason for hiding this comment

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

Great! Many thanks for the fix!

@marcelwa marcelwa merged commit bbb9a09 into main Mar 13, 2025
49 checks passed
@marcelwa marcelwa deleted the bdl-input-iterator-documentation-fix branch March 13, 2025 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@Drewniok Drewniok Drewniok approved these changes

Assignees

@marcelwa marcelwa

Labels
bug Something isn't working documentation Documentation is added or needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@marcelwa @Drewniok @actions-user