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

Implementing blacken docs #1750

Merged
merged 11 commits into from
Jan 5, 2023
Merged

Implementing blacken docs #1750

merged 11 commits into from
Jan 5, 2023

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Jan 3, 2023

@germa89 germa89 added Documentation Documentation related (improving, adding, etc) CI/CD Related with CICD, Github Actions, etc labels Jan 3, 2023
@germa89 germa89 requested a review from RobPasMue January 3, 2023 13:26
@germa89 germa89 self-assigned this Jan 3, 2023
@github-actions github-actions bot added Enhancement Improve any current implemented feature New Feature Request or proposal for a new feature labels Jan 3, 2023
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

LGTM!

.pre-commit-config.yaml Show resolved Hide resolved
@RobPasMue
Copy link
Member

Done! Ready to merge! :)

@codecov
Copy link

codecov bot commented Jan 3, 2023

Codecov Report

Merging #1750 (3854b70) into main (8e8ae3f) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1750      +/-   ##
==========================================
- Coverage   85.56%   85.51%   -0.05%     
==========================================
  Files          45       45              
  Lines        7660     7665       +5     
==========================================
+ Hits         6554     6555       +1     
- Misses       1106     1110       +4     

@RobPasMue
Copy link
Member

@germa89 feel free to merge it whenever you want =)

@germa89
Copy link
Collaborator Author

germa89 commented Jan 3, 2023

@germa89 feel free to merge it whenever you want =)

I was missing the badge.. Thank you @RobPasMue !! :)

@RobPasMue
Copy link
Member

@germa89 feel free to merge it whenever you want =)

I was missing the badge.. Thank you @RobPasMue !! :)

The workflow rules also had to be adapted to require the "pre-commit.ci - pr" stage instead of the "Code Style check" stage that you previously had. That was my other change =) Thanks for adding it to pre-commit.ci!

@RobPasMue
Copy link
Member

This is awesome @germa89... look at the last two commits!

ansys/pyansys#88

I created a modification to make pre-commit fail... and all of a sudden, pre-commit.ci created a commit on my PR to solve the issues!! This is only possible for those hooks that have reformatting solutions implemented but it's definitely a great addition!

@germa89
Copy link
Collaborator Author

germa89 commented Jan 5, 2023

This is awesome @germa89... look at the last two commits!

pyansys/pyansys#88

I created a modification to make pre-commit fail... and all of a sudden, pre-commit.ci created a commit on my PR to solve the issues!! This is only possible for those hooks that have reformatting solutions implemented but it's definitely a great addition!

Ohhh.. amazing.... #WhatATimeToBeAlive

alt

@germa89 germa89 merged commit 5f01a85 into main Jan 5, 2023
@germa89 germa89 deleted the feat/implementing-blacken-docs branch January 5, 2023 10:05
@germa89
Copy link
Collaborator Author

germa89 commented Jan 5, 2023

To fix the APDL sphinx lexer issues, I had to do some weird modification (basically wraps in single quotes everything that has a dot).

The lexer should be improved by adding these changes after pygments/pygments#2314 is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Related with CICD, Github Actions, etc Documentation Documentation related (improving, adding, etc) Enhancement Improve any current implemented feature New Feature Request or proposal for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants