Skip to content

Changed normal links to special :php*: links #1967

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

Merged
merged 9 commits into from
Nov 26, 2012
Merged

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Nov 24, 2012

No description provided.

weaverryan added a commit that referenced this pull request Nov 26, 2012
Changed normal links to special :php*: links
@weaverryan weaverryan merged commit bd1515b into symfony:2.0 Nov 26, 2012
@weaverryan
Copy link
Member

Awesome, thanks!

@wouterj
Copy link
Member Author

wouterj commented Nov 26, 2012

It turns out that the :phpmethod: role does not exists. We can do 2 things:

  1. Remove all these links and remove it from the contributing/doc/format page.
  2. Create a :phpmethod: role. This should be done in the fabpot/sphinx-php/sensio/sphinx/phpcode.py file. I have no knowledge of Python, but we should map: Class::method to http://php.net/class.method

I think we should do the second thing, what is your opinion about this @weaverryan and @fabpot?

@weaverryan
Copy link
Member

I've already reverted these (so done option 1).

I'd be very cool with option (2) as well - it looks like it's already implemented in that file, but just needs to have the role added as you mentioned. @wouterj - it should be quite simple - do you want to try it and PR over to fabpot's repository?

@wouterj
Copy link
Member Author

wouterj commented Nov 26, 2012

Thank you @weaverryan !

It is not implemented in that file yet (the php_method_role is for Symfony methods and not for phpmethods, we should create a php_phpmethod_role). I can try to create the php_phpmethod_role, but it will take some time before I have finished it.

EDIT: I did some research and I will create that role. It is quite easy.

fabpot added a commit to fabpot/sphinx-php that referenced this pull request Dec 20, 2012
This PR was merged into the master branch.

Commits
-------

ab2c3e7 Created phpmethod role

Discussion
----------

Created phpmethod role

We already have a `:phpfunction:` and `:phpclass:` role, it would be easy to have a `:phpmethod:` role to link to methods of PHP classes too. (see symfony/symfony-docs#1967 for more information)

This PR creates a basic role. I have copy/past some code from the `:method:` and `:phpclass:` roles to create this function. I just started with Python, so the code can be buggy.
@wouterj wouterj deleted the patch-15 branch December 31, 2012 14:11
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