Skip to content

chore(docs): review docs highlighted code snippets #1469

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

Merged
merged 1 commit into from
May 19, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As reported in the linked issue, some of the code snippets being highlighted in the docs had incorrect positioning. This meant that attention was directed towards wrong or non existing lines in those snippets.

The PR is the result of a review of all published pages and introduces a number of changes in the highlighted sections.

Once merged the it closes #1466.

Related issues, RFCs

Issue number: #1466

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this May 19, 2023
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label May 19, 2023
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label May 19, 2023
@dreamorosi dreamorosi merged commit 90a5240 into main May 19, 2023
@dreamorosi dreamorosi deleted the dreamorosi/issue1466 branch May 19, 2023 12:20
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 size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: fix inappropriate hilighted lines
1 participant