Skip to content

Make indentation consistent in pyguide.md #456

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

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from

Conversation

funcodeio
Copy link

No description provided.

@funcodeio
Copy link
Author

Since the guide's indentation is 4, it is good to have 4-space indentation in all examples through out the document. There were 2-space examples which made me confused.

@gpshead gpshead self-assigned this Jun 10, 2019
@gpshead
Copy link
Contributor

gpshead commented Jun 10, 2019

Thanks. Agreed this looks odd to people.

For what it's worth, the reason our guide is a bit messy this way is that we use two space indentation for our internal style but don't recommend that to the rest of the world which standardizes on four. We currently do not have an appropriate transformation setup to fix all of this in the examples as we publish the external version of the guide from our internal master.

I'm leaving this PR open assigned to me to deal with that one way or another.

@vapier vapier added lang:python The Python language and removed cla: yes labels Jul 8, 2024
@vapier
Copy link
Member

vapier commented Feb 21, 2025

so your point is def correct that the examples should be using 4 spaces. i think it might be a pain for us to handle internally though :(. we have an internal guide that we sanitize to produce the public guide.

@vapier
Copy link
Member

vapier commented Feb 21, 2025

ah, it looks like we do exactly that internally in some examples :(. we duplicate some code examples between internal (2 space) and external (4 space), but we didn't do it for all of them. oof.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang:python The Python language
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants