Skip to content

Conversation

mnocon
Copy link
Contributor

@mnocon mnocon commented May 27, 2025

Follow-up to #2758

Target: 5.0, 4.6

Created with the help of AI 🤖

Prompt used:

Add a link to the PHP API Reference to every line that mentions a service or method.

See the example in line 4.6 - adjust the rest of the file in the same manner

Using GPT-4.1 and Edit mode of GitHub Copilot

Zrzut ekranu 2025-05-27 o 15 08 56

Copy link

Preview of modified files

Preview of modified Markdown:

@mnocon mnocon marked this pull request as ready for review May 27, 2025 13:17
@mnocon mnocon requested a review from a team May 27, 2025 13:18
@ezrobot ezrobot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team May 27, 2025 13:18
Copy link
Contributor

@adriendupuis adriendupuis left a comment

Choose a reason for hiding this comment

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

All links seems to be the right ones.
Back to #2758, I wonder why not keep OrderServiceInterface as the reference, it would also match the link better.

### Get single order by identifier

To access a single order by using its string identifier, use the `OrderService::getOrderByIdentifier` method:
To access a single order by using its string identifier, use the [`OrderService::getOrderByIdentifier`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrderByIdentifier) method:
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not the OrderServiceInterface?

Suggested change
To access a single order by using its string identifier, use the [`OrderService::getOrderByIdentifier`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrderByIdentifier) method:
To access a single order by using its string identifier, use the [`OrderServiceInterface::getOrderByIdentifier`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrderByIdentifier) method:

(Same remarks for the following methods below.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! Applied (manually) in ef3324d

@mnocon mnocon merged commit 7fa5cd2 into 5.0 May 27, 2025
7 checks passed
@mnocon mnocon deleted the order-api branch May 27, 2025 14:36
mnocon added a commit that referenced this pull request May 27, 2025
* Added other links to PHP API Reference

* OrderService -> OrderServiceInterface
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