[PHPDoc] Improved ContentService doc for API reference #379
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adriendupuis
commented
Jun 7, 2024
adamwojs
approved these changes
Jun 10, 2024
adriendupuis
force-pushed
the
improved_contentservice_phpdoc
branch
from
0700fc8
to
f33c2e7
Compare
adriendupuis
commented
Jun 21, 2024
adriendupuis
commented
Jun 21, 2024
adriendupuis
commented
Jun 21, 2024
adriendupuis
commented
Jun 21, 2024
|
@adriendupuis Could you please address issues reported by phpstan? |
adriendupuis
commented
Jun 24, 2024
adriendupuis
commented
Jun 24, 2024
7 tasks
konradoboza
reviewed
Jun 28, 2024
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException if the content or version with the given id and languages does not exist | ||
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the user has no access to read content and in case of un-published content: read versions | ||
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException if the content or version with the given id and languages doesn't exist. | ||
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of un-published content, "read versions". |
There was a problem hiding this comment.
Suggested change
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of un-published content, "read versions". | |
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content" or in case of unpublished content - "read versions". |
There was a problem hiding this comment.
@konradoboza I'm a bit surprised by this usage of dashes. I'll check if it's regular grammar.
There was a problem hiding this comment.
I am not 100% sure if it's better. It's not a biggie to me tbh.
There was a problem hiding this comment.
Suggested change
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of un-published content, "read versions". | |
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of unpublished content, "read versions". |
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException - if the content or version with the given remote id does not exist | ||
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the user has no access to read content and in case of un-published content: read versions | ||
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException if the content or version with the given remote id doesn't exist. | ||
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of un-published content, "read versions". |
There was a problem hiding this comment.
Suggested change
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of un-published content, "read versions". | |
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content" or in case of unpublished content - "read versions". |
There was a problem hiding this comment.
Suggested change
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of un-published content, "read versions". | |
| * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException if the user has no access to "read content", or, in case of unpublished content, "read versions". |
| * | ||
| * @param \Ibexa\Contracts\Core\Repository\Values\User\User $user The user to load drafts for, if defined, otherwise drafts for current-user | ||
| * @param \Ibexa\Contracts\Core\Repository\Values\User\User|null $user The user to load drafts for, if defined; otherwise drafts for current user. |
There was a problem hiding this comment.
Suggested change
| * @param \Ibexa\Contracts\Core\Repository\Values\User\User|null $user The user to load drafts for, if defined; otherwise drafts for current user. | |
| * @param \Ibexa\Contracts\Core\Repository\Values\User\User|null $user The user to load drafts for, if defined. Otherwise - drafts for current user. |
There was a problem hiding this comment.
Suggested change
| * @param \Ibexa\Contracts\Core\Repository\Values\User\User|null $user The user to load drafts for, if defined; otherwise drafts for current user. | |
| * @param \Ibexa\Contracts\Core\Repository\Values\User\User|null $user The user to load drafts for. If `null`, the current user's drafts are loaded. |
alongosz
changed the title
|
@adriendupuis this one needs rebase. Are all prior review remarks resolved and is it ready for another round of review? |
Co-authored-by: Konrad Oboza <konrad.oboza@ibexa.co>
adriendupuis
force-pushed
the
improved_contentservice_phpdoc
branch
from
b77b3c9
to
76f9c88
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Format PHPDoc (capitalize description except
@thows, trailing period, etc.)Enhance a bit (add few
@see, etc.)[⚠️ Outdated] Preview rendering in PHP API Reference: https://ez-systems-developer-documentation--2413.com.readthedocs.build/en/2413/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html
Compare with current 4.6.7: https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html
TODO: Rebuild the preview after last changes.
For QA:
Documentation: