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

Added Indentation section to document the exact exapected behavior of… #65

Merged
merged 1 commit into from
Nov 10, 2024

Conversation

mipo256
Copy link
Contributor

@mipo256 mipo256 commented Oct 27, 2024

As discussed in this issue, there turned out to be a lot of undocumented behavior in terms of indentation style in use. This PR aims to address the problem mentioned in the aforementioned issue by documenting the behavior of indentation options.

CC: @xuhdev


📚 Documentation preview 📚: https://editorconfig-specification--65.org.readthedocs.build/

@mipo256 mipo256 force-pushed the indent_style_clarification branch from 5b1493a to 431d12d Compare October 27, 2024 13:11
@mipo256
Copy link
Contributor Author

mipo256 commented Nov 5, 2024

Hey @xuhdev, any chance to review the PR soon? We'll soon complete the plugin, we're going to need the clarification to justify the behavior of the plugin.

Copy link
Member

@xuhdev xuhdev left a comment

Choose a reason for hiding this comment

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

Sorry for the delay and thanks for the writeup!

I've made a suggestion to rewrite the bullet point, and some grammatical changes in the indentation section.

index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
@xuhdev xuhdev self-assigned this Nov 5, 2024
@mipo256
Copy link
Contributor Author

mipo256 commented Nov 6, 2024

Hey @xuhdev!
Thanks for suggestions, I've applied almost all of them. There are just a couple of cases where I proposed changes based on your suggestions as well. Please, take a look at it :)

@mipo256 mipo256 requested a review from xuhdev November 6, 2024 07:31
index.rst Outdated Show resolved Hide resolved
@xuhdev xuhdev assigned mipo256 and unassigned xuhdev Nov 8, 2024
@mipo256
Copy link
Contributor Author

mipo256 commented Nov 8, 2024

Hey @xuhdev!
Thanks for the review. I've addressed the remaining issues in the following commit: 4343eef

P.S: Once we're okay with the final state of the PR, I'll squash the commits into a single one, now I'm retaining history for the ease of review.

@mipo256 mipo256 requested a review from xuhdev November 8, 2024 10:35
Copy link
Member

@xuhdev xuhdev 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 to me now! I added some comments for minor language and format changes. Other than those, the PR is good to go.

index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
@mipo256 mipo256 requested a review from xuhdev November 10, 2024 06:14
@mipo256
Copy link
Contributor Author

mipo256 commented Nov 10, 2024

Hey @xuhdev!
I agree with all of yours suggestions, I've fixed them, can you re-review?) I'll squash the commits once you'll approve

Copy link
Member

@xuhdev xuhdev left a comment

Choose a reason for hiding this comment

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

Perfect! GitHub can also squash merge, do you want me go ahead, or you have something else in mind?

@mipo256 mipo256 force-pushed the indent_style_clarification branch from c721436 to 7036714 Compare November 10, 2024 09:20
@mipo256
Copy link
Contributor Author

mipo256 commented Nov 10, 2024

No, everything's good. I've squashed the commits to ease the job for you 😄 You can proceed with merging it into the master trunk 😄

@mipo256 mipo256 requested a review from xuhdev November 10, 2024 09:22
@xuhdev xuhdev merged commit cf6fb9f into editorconfig:master Nov 10, 2024
1 check passed
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