Skip to content

Conversation

@adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Jun 7, 2024

Question Answer
JIRA Ticket
Versions master, 4.6
Edition

Summary

Enhance or fix few PHP API Reference's templates.

  • components/interface-title.html.twig: Fix FQCN
  • components/method-arguments.html.twig:
    • Link to the constant in "Default value" col.
    • Use - instead of None in empty "Default value" col.
    • Use - in empty "Description" col.
    • Fix empty CSS class assignment to empty col.
  • components/method-response.html.twig: Remove the "—" separation between response type and response description.
  • components/tags.html.twig: Hide final tag.
  • base.css.twig:
    • Fix paragraph top and bottom margin in method param table's description cell.
    • Avoid new line in param name or type.

Notes:

Comparison between old current and new preview

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

# Conflicts:
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-DateRange.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventCollection.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventGroup.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventList.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-LocationServiceDecorator.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Rest-Input-ParsingDispatcher.html
# Conflicts:
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-DateRange.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventAction-EventActionCollection.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventCollection.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventGroup.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventList.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventQueryBuilder.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Calendar-EventSource-InMemoryEventSource.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Event-Mapper-ResolveMissingFieldEvent.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-FieldType-DefaultDataFieldStorage.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-LocationServiceDecorator.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html
#	docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Rest-Input-ParsingDispatcher.html
@adriendupuis adriendupuis marked this pull request as ready for review June 14, 2024 09:01
@adriendupuis adriendupuis marked this pull request as draft June 14, 2024 12:50
@adriendupuis adriendupuis changed the title PHP API Ref enhancement PHP API Ref enhancement (June first batch) Jun 14, 2024
@adriendupuis adriendupuis marked this pull request as ready for review June 14, 2024 13:49
@adriendupuis adriendupuis requested review from adamwojs and mnocon June 14, 2024 14:13
Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

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

I went over the changes locally (skipping the autogenerated ones) and I think they make sense 💪

Thank you for providing this detailed description (with comparisons), without it it would be very hard to review this

@adriendupuis adriendupuis merged commit 2c7e620 into master Jun 17, 2024
@adriendupuis adriendupuis deleted the enh-php_api_ref branch June 17, 2024 09:36
adriendupuis added a commit that referenced this pull request Jun 17, 2024
(cherry picked from commit 2c7e620)
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.

2 participants