Skip to content

1593 Fix ABM logger description - #1594

Merged
xsaschako merged 1 commit into
mainfrom
1593-fix-abm-logger-description
Oct 8, 2026
Merged

xsaschako merged 1 commit into
mainfrom
1593-fix-abm-logger-description

Conversation

@xsaschako

@xsaschako xsaschako commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • Fix broken link in docs/source/cpp/io.rst (History section): cpp/simulations/abm.cpp no longer exists, so the link now points to cpp/examples/abm_history_object.cpp.
  • Update the accompanying sentence to match that example (one History object with two Loggers defined in the example passed to the simulation), instead of "several History objects in use".

If need be, add additional information and what the reviewer should look out for in particular:

  • Docs-only change; the ReadTheDocs preview was not built locally.

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below).
  • New code adheres to coding guidelines.
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.).
  • Tests are added for new functionality and a local test run was successful (with and without OpenMP).
  • Appropriate documentation within the code (Doxygen) for new functionality has been added in the code.
  • Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation and checked in the preview.
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added.
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed.
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.).
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease).
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.).
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

Closes #1593

@xsaschako
xsaschako requested review from HenrZu and charlie0614 and removed request for HenrZu October 8, 2026 09:22
@codecov

codecov Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.48%. Comparing base (572e802) to head (e1eee65).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1594   +/-   ##
=======================================
  Coverage   97.48%   97.48%           
=======================================
  Files         190      190           
  Lines       16035    16035           
=======================================
  Hits        15632    15632           
  Misses        403      403           

☔ View full report in Codecov by Harness.
📢 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.

cpp/simulations/abm.cpp no longer exists. Link to cpp/examples/abm_history_object.cpp
instead and update the description to match what that example shows.
@xsaschako
xsaschako force-pushed the 1593-fix-abm-logger-description branch from 6719fc4 to e1eee65 Compare October 8, 2026 10:03
@mknaranja
mknaranja marked this pull request as draft October 8, 2026 10:17
@xsaschako
xsaschako marked this pull request as ready for review October 8, 2026 10:52
@xsaschako
xsaschako merged commit 0888d6c into main Oct 8, 2026
125 checks passed
@xsaschako
xsaschako deleted the 1593-fix-abm-logger-description branch October 8, 2026 11:50
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.

Fix ABM logger description

2 participants