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

DX: make doc examples prettier #5585

Merged
merged 1 commit into from
Apr 6, 2021
Merged

DX: make doc examples prettier #5585

merged 1 commit into from
Apr 6, 2021

Conversation

kubawerlos
Copy link
Contributor

  • Makes all diff for doc examples having whote file content.
  • Removes the line numbers e.g. @@ -1,2 +1,2 @@ from diffs.

All interesting changes are in src/Documentation/DocumentationGenerator.php file.

Ping @julienfalque for review.

@coveralls
Copy link

coveralls commented Mar 31, 2021

Coverage Status

Coverage decreased (-0.005%) to 91.846% when pulling 23e5515 on kubawerlos:dx-make-doc-examples-pretier into f01521b on FriendsOfPHP:2.18.

@@ -51,6 +51,7 @@ final class DocumentationGenerator
public function __construct()
{
$this->differ = new Differ(new UnifiedDiffOutputBuilder([
'contextLines' => 1024, // number large enough to have all lines in diff
Copy link
Member

Choose a reason for hiding this comment

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

👍

@keradus keradus added this to the 2.18.5 milestone Apr 4, 2021
@kubawerlos kubawerlos added the RTM Ready To Merge label Apr 5, 2021
@keradus keradus removed the RTM Ready To Merge label Apr 6, 2021
@keradus
Copy link
Member

keradus commented Apr 6, 2021

Thank you @kubawerlos.

@keradus keradus merged commit 02675fc into PHP-CS-Fixer:2.18 Apr 6, 2021
@keradus keradus mentioned this pull request Apr 6, 2021
keradus added a commit that referenced this pull request Apr 6, 2021
This PR was merged into the 2.18 branch.

Discussion
----------

DX: regenerate docs

follow up after #5585

Commits
-------

82cf209 DX: regenerate docs
@kubawerlos kubawerlos deleted the dx-make-doc-examples-pretier branch April 6, 2021 19:32
keradus added a commit that referenced this pull request Apr 7, 2021
…er (keradus)

This PR was squashed before being merged into the 2.18 branch.

Discussion
----------

DX: DocumentationGenerator - no need to re-configure Differ

follows #5585 ,
@kubawerlos , we have actually a FullDiffer class ready for exact case how use configured the differ

Commits
-------

bb4b790 DX: DocumentationGenerator - no need to re-configure Differ
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants