Skip to content

[Book] link to the API documentation #4640

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

Closed
wants to merge 1 commit into from

Conversation

xabbuh
Copy link
Member

@xabbuh xabbuh commented Dec 12, 2014

Q A
Doc fix? no
New docs? no
Applies to all
Fixed tickets

@xabbuh
Copy link
Member Author

xabbuh commented Dec 12, 2014

We talk about the stable API, but actually don't link to the generated API documentation.

@@ -20,6 +20,10 @@ in the stable API is in order to fix a security issue.
The stable API is based on a whitelist, tagged with `@api`. Therefore,
everything not tagged explicitly is not part of the stable API.

.. seealso::

You can browse the Symfony API documentation on `symfony.com`_.
Copy link
Member

Choose a reason for hiding this comment

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

I would prefer api.symfony.com

@xabbuh
Copy link
Member Author

xabbuh commented Dec 16, 2014

PR updated

@weaverryan
Copy link
Member

Makes good sense - thanks Christian!

weaverryan added a commit that referenced this pull request Dec 20, 2014
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #4640).

Discussion
----------

[Book] link to the API documentation

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Commits
-------

fae8c40 link to the API documentation
@xabbuh xabbuh closed this Dec 20, 2014
@xabbuh xabbuh deleted the api-docs-link branch December 20, 2014 22:12
@xabbuh
Copy link
Member Author

xabbuh commented Dec 20, 2014

@weaverryan Closing here then. Thanks for picking the right branch, Ryan. :)

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.

3 participants