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

Add API Docs Description to Interface Methods #156

Merged
merged 6 commits into from
Jul 23, 2021
Merged

Add API Docs Description to Interface Methods #156

merged 6 commits into from
Jul 23, 2021

Conversation

AlexandruGG
Copy link
Collaborator

@AlexandruGG AlexandruGG commented Jul 20, 2021 •
edited
Loading

This PR:

  • Adds descriptions to Collection interface methods based on the API docs
  • Fixed/tweaked a few things in the API docs

Related to #135 (comment).

@AlexandruGG
Copy link
Collaborator Author

The static analysis failures are all due to the non-empty-string PHPStan issues.

@AlexandruGG AlexandruGG marked this pull request as ready for review July 22, 2021 21:07
@AlexandruGG
Copy link
Collaborator Author

@drupol this is ready for review. The documentation was good, but now it's looking even better!

@AlexandruGG AlexandruGG mentioned this pull request Jul 22, 2021
Merged
5 tasks
drupol
drupol approved these changes Jul 22, 2021
View reviewed changes
Copy link
Collaborator

@drupol drupol left a comment

Choose a reason for hiding this comment

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

Excellent, thanks !!!! 💯

@drupol drupol added the enhancement New feature or request label Jul 22, 2021
@AlexandruGG
Copy link
Collaborator Author

@drupol thanks for taking a look at this!

I can't actually merge it because of the failing required checks (due to the PHPStan issue - phpstan/phpstan#5372).

Could you merge it for me please?

@drupol drupol merged commit ff9f1e4 into master Jul 23, 2021
@drupol drupol deleted the feature/operations-interfaces-docs branch July 23, 2021 20:26
@drupol
Copy link
Collaborator

drupol commented Jul 23, 2021

Amazing work, thanks again :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drupol drupol drupol approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexandruGG @drupol