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

[Disposable] Enhanced contracts PHPDoc #479

Closed
wants to merge 3 commits into from
Closed

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Feb 13, 2025

🎫 Issue IBX-XXXXX

Related PRs:

Description:

See #463

For QA:

Documentation:

For more details see #463

Key changes:

* Enhance `DateMetadata::TRASHED` phpdoc

* Enhance `Criterion::getSpecifications()` phpdoc

* Enhance `Specifications` phpdoc

* Capable.php: Fix phpdoc summary

* VersionBuilder.php: Fix phpdoc summary, arrays and self usages

* ConstraintViolationAdapter's PHPDoc: Add a summary, reword description

* Enhance `Criterion::getSpecifications()` phpdoc

* Enhance `DateMetadata::TRASHED` phpdoc

* Enhance `DateMetadata` phpdoc

* Enhance `UserMetadata` phpdoc

* Enhance `DateMetadata` phpdoc

* Enhance `Capable` phpdoc

* Enhance `Criterion` phpdoc

* Enhance `UserMetadata` phpdoc (fix typo)

* Enhance `UserMetadata` phpdoc

* Enhance `FieldType\Generic\Type` phpdoc

* Enhance `Limitation\Type` phpdoc

* LocationService: Fix count() phpdoc

* Enhance `LocationService` phpdoc

* Enhance `Location` phpdoc

* Enhance `Location` phpdoc: @deprecated can't be nested nor used inline.

* Enhance `Location` phpdoc: Add an internal link

* Enhance `ValueObject` phpdoc

* Enhance `FieldType\Generic\Type` phpdoc: Fix internal links

* Enhance `FieldType\FieldType` phpdoc: Fix code blocks

* `Limitation\Type`: type array keys

* ValueObject: Format desc
Copy link
Member

@alongosz alongosz left a comment

Choose a reason for hiding this comment

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

@adriendupuis Product packages undergo Ibexa GitFlow. We merge up the changes, instead of cherry-picking them, so we keep consistent chain of changes history and avoid re-introducing the same change multiple times.

What you need to do is:

  1. checkout current version of 4.6 and main branches
    in your local checkout of ibexa/core:
git checkout 4.6
git pull 
git status # make sure it's clean
git checkout main
git pull
git status # make sure it's clean
  1. merge 4.6
git merge 4.6
  1. Resolve conflicts - if these are not just yours conflict, but coming from other devs - ask for help.
  2. Commit changes with the commit message Merged branch '4.6'
  3. Either
    a) push directly
git push origin main

b) if you're not sure if you did it right, you can update this PR to be a merging PR, meaning including your merge commit from point 4. Then I can merge it in a fast forward way

git push origin --force-with-lease enh-phpdoc

@adriendupuis adriendupuis changed the title Enhanced contracts PHPDoc [Disposable] Enhanced contracts PHPDoc Feb 14, 2025
@adriendupuis adriendupuis added Invalid This doesn't seem right Investigation 🕵️ labels Feb 14, 2025
@adriendupuis
Copy link
Contributor Author

@adriendupuis Product packages undergo Ibexa GitFlow. We merge up the changes, instead of cherry-picking them, so we keep consistent chain of changes history and avoid re-introducing the same change multiple times.

@alongosz This is a disposable PR just to study the conflicts for incoming #480

@adriendupuis
Copy link
Contributor Author

I think I manage to solve conflicts. Solution used in #481

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Invalid This doesn't seem right Investigation 🕵️
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants