Skip to content

[skip changelog] Use consistent indentation style in example snippets of package_index.json specification #815

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 10, 2020
Merged

[skip changelog] Use consistent indentation style in example snippets of package_index.json specification #815

merged 2 commits into from
Jul 10, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 10, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing 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?

Docs update

  • What is the current behavior?

Some of the indentation of the example snippets in the package_index.json specification is inconsistent.

  • What is the new behavior?

All indentation of example snippets in the package_index.json specification is consistent.

  • Does this PR introduce a breaking change?

No.

per1234 added 2 commits July 9, 2020 20:42
@per1234
Use consistent index size for snippets in package_index.json specific…
e37567d 
…ation

The predominant index size in the example snippets (as well as in Arduino's official package_index.json file) is two spaces. However, at some places in the example snippets indents of three or four spaces were used.
@per1234
Use true indentation level for package definition example snippet
361ca73 
All other example snippets in the documentation use the indentation level they will have in the full document, so for consistency the package definition snippet should do the same.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 10, 2020
@per1234 per1234 merged commit c4db1dd into arduino:master Jul 10, 2020
@per1234 per1234 deleted the package-index-indentation branch July 10, 2020 11:35
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsora rsora rsora approved these changes

Assignees

@per1234 per1234

Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@per1234 @rsora