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

Standardize indentation for code snippets in the README. #184

Merged
merged 2 commits into from
Sep 30, 2022

Conversation

TheOnlyWayUp
Copy link
Contributor

From what I noticed while reading the README,

  • Short Python and Bash Snippets have no Indentation
  • Longer Python Snippets have 4 Spaces ( ) of indentation

I did my best to judge what would be considered long/short and added indentation accordingly, but there is a clear lack of standardization with the indentation for snippets, I'd suggest removing indentation completely, to make copy pasting easier :)

By indentation, I mean the spaces added to the start of a line but not for Python's sake

    import tinytuya

vs

import tinytuya

Thanks for the great project, everything is extremely well documented in the README and setting things up was a breeze <3

@TheOnlyWayUp
Copy link
Contributor Author

Please keep in mind, this pull request to bring more attention to this issue. It may not add indentation as you envisioned. I strongly suggest you rethink indentation for code snippets and possibly remove it altogether.

Thanks!

@jasonacox
Copy link
Owner

Hi @TheOnlyWayUp - thank you for this PR! I completely agree with your points. Let's remove the spaces. Are you willing to do that and update the PR? I would prefer you get the credit.

Thanks for your help!

@TheOnlyWayUp
Copy link
Contributor Author

Are you willing to do that and update the PR? I would prefer you get the credit.

I'll do it within the next hour :)

@TheOnlyWayUp
Copy link
Contributor Author

@jasonacox Please take a look at TheOnlyWayUp/tinytuya/patch-1/README.md

If everything is satisfactory, I think this pull request can be merged. Thanks for the cool library!

@jasonacox jasonacox merged commit f400ae9 into jasonacox:master Sep 30, 2022
@jasonacox
Copy link
Owner

It looks so much better!!! Thanks @TheOnlyWayUp ! Merged.

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