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.

Sign up for GitHub

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

Jump to bottom

IBX-4929: Fix PhpDoc #280

Merged
merged 6 commits into from
Oct 20, 2023
Merged

IBX-4929: Fix PhpDoc #280

merged 6 commits into from
Oct 20, 2023

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Oct 11, 2023 •
edited
Loading

Question Answer
JIRA issue IBX-4929
Type improvement
Target Ibexa version v4.6
BC breaks no
  • Fix optional array keys syntax in ConfigurationDumper. (note: phpDocumentor 3 parse the file even if it respects the @internal tag and doesn't display it in the resulting reference.)
    • Remove fixed errors from phpstan-baseline.neon
  • Fix description Markdown: remove unneeded list item bullets.

Checklist:

  • Provided PR description.
  • Tested the solution manually.
  • Provided automated test coverage.
  • Checked that target branch is set correctly (main for features, the oldest supported for bugs).
  • Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
  • Asked for a review (ping @ibexa/engineering).

adriendupuis and others added 5 commits October 16, 2023 15:27
@adriendupuis
ConfigurationDumper.php: Move to @phpstam-param
470df61 
Avoid the following error:
Unable to parse file "vendor/ibexa/core/src/contracts/Container/Encore/ConfigurationDumper.php", an error was detected: Unexpected token ":", expected '}'
@adriendupuis
phpDoc: Remove list bullets
7171013 
phpDoc description is interpreted as Markdown. Those hyphens were generating one-item unordered lists.
@adriendupuis
Update src/contracts/Container/Encore/ConfigurationDumper.php
c008679
@adriendupuis
Update src/contracts/Container/Encore/ConfigurationDumper.php
1097f31
@adriendupuis
phpstan-baseline.neon: Remove fixed errors
f0914bd
@adriendupuis
ConfigurationDumper.php: Back to @param
486539c 
The syntax is accepted by phpDocumentor 3.3.1 and 3.4.1;
The syntax error was only due to question mark misplacement.
@sonarcloud
Copy link

sonarcloud bot commented Oct 16, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 2 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@adriendupuis adriendupuis marked this pull request as ready for review October 16, 2023 16:35
@adriendupuis
Copy link
Contributor Author

adriendupuis commented Oct 17, 2023 •
edited
Loading

Side note: the complexe syntax array<string, array<string, array{'deprecated'?: bool, 'alternative'?: string}>> is well accepted by phpDocumentor 3.3.1 and 3.4.1. If I remove the @internal, I have this with phpDocumentor 3.4.1:
Capture d’écran 2023-10-17 à 11 24 20

@adriendupuis
Copy link
Contributor Author

Hi @ibexa/engineering

Can I have a second approval or a feedback, please?

@adamwojs adamwojs merged commit 09972d4 into main Oct 20, 2023
26 checks passed
@adamwojs adamwojs deleted the fix-phpdoc branch October 20, 2023 05:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamwojs adamwojs adamwojs approved these changes

@kisztof kisztof kisztof approved these changes

Assignees
No one assigned
Labels
Ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@adriendupuis @adamwojs @kisztof