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, ...)

Fix and improve some markdown files.

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

There are some things to improve in the docs.

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

  • Removed the dependency versions from the README file.
  • Fixed formatting in markdown content and XML code blocks.
  • Rephrased one paragraph.

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 a review from Chrico as a code owner January 27, 2025 08:01
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.

I guess it's fine. Maybe just 1 tiny change before merge. :)

@tfrommen tfrommen merged commit 5eef494 into main Jan 27, 2025
1 check passed
@tfrommen tfrommen deleted the docs branch January 27, 2025 08:46
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