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

fix multi_line_output_modes docs #2096

Merged
merged 3 commits into from
Feb 26, 2025
Merged

fix multi_line_output_modes docs #2096

merged 3 commits into from
Feb 26, 2025

Conversation

xinydev
Copy link
Contributor

@xinydev xinydev commented Feb 15, 2023

  • There should not be a comma after the last import in the Vertical Hanging Indent format.
  • Removing extra spaces.

The reason why I noticed this error is that I was using both isort and black, which can cause conflicts. The last import in the code formatted by black has a comma. After consulting the documentation, I found that the configuration for isort's Vertical Hanging Indent is the same as the code formatted by black. However, after configuring isort with Vertical Hanging Indent, I found that there was still a conflict between the two tools. Finally, I discovered that the isort documentation contained this error, and the last import should not have a comma.
I ultimately resolved the compatibility issue by using profile="black", but I do think that the error in the documentation should be fixed. Some people may encounter the same issue as me and be misled by the extraneous comma in the final import statement.

- There should not be a comma after the last import in the Vertical
Hanging Indent format.
- Removing extra spaces.

Signed-off-by: Xin Yang <xinydev@gmail.com>
@codecov
Copy link

codecov bot commented Feb 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.16%. Comparing base (790bb06) to head (ee477e9).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2096   +/-   ##
=======================================
  Coverage   99.16%   99.16%           
=======================================
  Files          40       40           
  Lines        3101     3101           
  Branches      680      680           
=======================================
  Hits         3075     3075           
  Misses         15       15           
  Partials       11       11           

Copy link
Collaborator

@staticdev staticdev left a comment

Choose a reason for hiding this comment

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

Thanks @xinydev and @DanielNoord, LGTM.

@staticdev staticdev added this pull request to the merge queue Feb 26, 2025
Merged via the queue into PyCQA:main with commit c8ab4a5 Feb 26, 2025
21 checks passed
@xinydev xinydev deleted the fix-docs branch March 3, 2025 02:43
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.

3 participants