Skip to content

Add links to documentation to ApiResource properties#3204

Merged
teohhanhui merged 1 commit into
api-platform:2.5from
edamov:master
Oct 25, 2019
Merged

Add links to documentation to ApiResource properties#3204
teohhanhui merged 1 commit into
api-platform:2.5from
edamov:master

Conversation

@edamov

@edamov edamov commented Oct 23, 2019

Copy link
Copy Markdown
Contributor
Q A
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tickets fixes api-platform/docs#868
License MIT
Doc PR api-platform/docs#...

I started work on api-platform/docs#868 because it was marked as good first issue :)
First, I added links to documentation for API Resource properties and sort properties alphabetically.

But there are some points I don't understand from this issue.
What should we do with @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112 in the class ApiResource?
I found this PR but still can't understand.

@teohhanhui

teohhanhui commented Oct 25, 2019

Copy link
Copy Markdown
Contributor

What should we do with @see Haehnchen/idea-php-annotation-plugin#112 in the class ApiResource?

Nothing. 😄 But it's less important than the link to documentation entry, so keep it below.

@teohhanhui

Copy link
Copy Markdown
Contributor

Hmm... Actually, this does not address api-platform/docs#868, but I think this is something worth doing as well. WDYT @dunglas?

Comment thread src/Annotation/ApiResource.php Outdated
Comment thread src/Annotation/ApiResource.php Outdated
Comment thread src/Annotation/ApiResource.php Outdated
Comment thread src/Annotation/ApiResource.php
Comment thread src/Annotation/ApiResource.php
Comment thread src/Annotation/ApiResource.php
Comment thread src/Annotation/ApiResource.php Outdated
Comment thread src/Annotation/ApiResource.php Outdated
@teohhanhui

teohhanhui commented Oct 25, 2019

Copy link
Copy Markdown
Contributor

Thanks for squashing! 😄

Can you target 2.5 instead?

git reset --hard origin/2.5
git cherry-pick 254074a

@edamov edamov changed the base branch from master to 2.5 October 25, 2019 10:02
@edamov

edamov commented Oct 25, 2019

Copy link
Copy Markdown
Contributor Author

Thanks for squashing!

Can you target 2.5 instead?

git reset --hard origin/2.5
git cherry-pick 254074a

oops. I do something in a wrong way

@edamov edamov changed the base branch from 2.5 to master October 25, 2019 10:03
@teohhanhui

Copy link
Copy Markdown
Contributor

I can take care of it if you'd like. 😄

@edamov

edamov commented Oct 25, 2019

Copy link
Copy Markdown
Contributor Author

I need to try :)

@edamov

edamov commented Oct 25, 2019

Copy link
Copy Markdown
Contributor Author

It got only worse 🤕 Now it has conflicts

@teohhanhui

Copy link
Copy Markdown
Contributor

Did you try following the steps I've provided? 😄

@edamov

edamov commented Oct 25, 2019

Copy link
Copy Markdown
Contributor Author

Yes. But I had no success :( I had for some reasons second master branch

@teohhanhui

Copy link
Copy Markdown
Contributor

Okay, no worries. I'll take care of this.

@edamov

edamov commented Oct 25, 2019

Copy link
Copy Markdown
Contributor Author

Thanks a lot for your help and your time!

@teohhanhui

Copy link
Copy Markdown
Contributor

Note for next time: Always use a topic branch (e.g. feature/api-resource-annotation-link-docs) when creating a PR. Do not use the master branch (or others like 2.5).

@teohhanhui teohhanhui changed the title WIP: Add links to documentation for API Resource properties. Add links to documentation to ApiResource properties Oct 25, 2019
@teohhanhui teohhanhui changed the base branch from master to 2.5 October 25, 2019 11:08
@teohhanhui teohhanhui merged commit a3f3fe1 into api-platform:2.5 Oct 25, 2019
@teohhanhui

Copy link
Copy Markdown
Contributor

Thanks @edamov! 🎉

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants