Skip to content

Added page "How do I ..."#90

Merged
forman merged 6 commits intomainfrom
forman-66-how_do_i_guide
May 30, 2024
Merged

Added page "How do I ..."#90
forman merged 6 commits intomainfrom
forman-66-how_do_i_guide

Conversation

@forman
Copy link
Member

@forman forman commented Mar 25, 2024

Added initial documentation page "How do I ...".

Closes #66

Checklist (strike out non-applicable):

  • Changes documented in CHANGES.md
  • Related issue exists and is referred to in the PR description and CHANGES.md
  • Added docstrings and API docs for any new/modified user-facing classes and functions
  • Changes/features documented in docs/*
  • Unit-tests adapted/added for changes/features
  • Test coverage remains or increases (target 100%)

@forman forman self-assigned this Mar 25, 2024
@forman forman added the documentation Improvements or additions to documentation label Mar 25, 2024
@codecov
Copy link

codecov bot commented Mar 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.93%. Comparing base (ab74336) to head (f589cf0).
Report is 7 commits behind head on main.

Current head f589cf0 differs from pull request most recent head 88706e5

Please upload reports for the commit 88706e5 to get more accurate results.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #90   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files          30       30           
  Lines        1454     1454           
=======================================
  Hits         1453     1453           
  Misses          1        1           

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

@forman forman requested a review from pont-us May 30, 2024 09:25
@forman forman marked this pull request as ready for review May 30, 2024 09:56
Copy link
Member

@pont-us pont-us left a comment

Choose a reason for hiding this comment

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

Just a couple of typos :)

Co-authored-by: Pontus Lurcock <pontus.lurcock@brockmann-consult.de>
Copy link
Member Author

@forman forman left a comment

Choose a reason for hiding this comment

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

Thanks!

@forman forman merged commit 5a239f4 into main May 30, 2024
@forman forman deleted the forman-66-how_do_i_guide branch May 30, 2024 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Address runtime performance in user guide

2 participants