Skip to content
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.

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

Update README.md #15495

Merged
merged 5 commits into from
Aug 9, 2023
Merged

Update README.md #15495

merged 5 commits into from
Aug 9, 2023

Conversation

CajNoble
Copy link
Contributor

@CajNoble CajNoble commented Aug 7, 2023

Noticed that the paragraph following the code the bloc seemed to inherit a plain text format. This appears to have been removed by removing the indentation.

What does this PR do?

This PR should make the bloc of text following a code block its own paragraph. It appears to have inherited a plain text format due to the indentation.

Motivation

The formatting looked out of line with our normal documentation. This change should re-align to our formatting expectations.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have changelog/ and integration/ labels attached
  • If the PR doesn't need to be tested during QA, please add a qa/skip-qa label.

Noticed that the paragraph following the code the bloc seemed to inherit a plain text format. This appears to have been removed by removing the indentation.
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

Looks good - thank you for this fix!

@FlorentClarret FlorentClarret merged commit 4b38a80 into master Aug 9, 2023
22 checks passed
@FlorentClarret FlorentClarret deleted the CajNoble-patch-1 branch August 9, 2023 05:52
@vivek-datadog vivek-datadog added the qa/skip-qa Automatically skip this PR for the next QA label Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants