Skip to content

Conversation

@tfrommen
Copy link
Member

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Update and improve the readme and the docs pages.

  • Remove leading $ terminal indicator for shell commands.
  • Add shell type for fenced code block (where missing).
  • Include missing Application Flow documentation in readme.
  • Replace tabs with spaces.
  • Fix link to LICENSE file in docs page. (The markdown was broken, but the docs pages don't have access to files outside of the docs folder anyway.)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

@tfrommen tfrommen requested review from Chrico and gmazzap March 28, 2024 08:24
@codecov
Copy link

codecov bot commented Mar 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.87%. Comparing base (ef0143d) to head (3cc753e).

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #43   +/-   ##
=========================================
  Coverage     98.87%   98.87%           
  Complexity      192      192           
=========================================
  Files             9        9           
  Lines           531      531           
=========================================
  Hits            525      525           
  Misses            6        6           
Flag Coverage Δ
unittests 98.87% <ø> (ø)

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.

Copy link
Member

@Chrico Chrico left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏻

@Chrico Chrico merged commit 7538809 into master Apr 2, 2024
@Chrico Chrico deleted the docs branch April 2, 2024 06:28
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