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

Deprecate @link and add relations to @see #2

Closed
mvriel opened this issue Aug 9, 2013 · 4 comments
Closed

Deprecate @link and add relations to @see #2

mvriel opened this issue Aug 9, 2013 · 4 comments

Comments

@mvriel
Copy link
Member

mvriel commented Aug 9, 2013

This proposal intends to add a relation type, or role, to the @see tag while keeping the tag backwards compatible.

Syntax proposal:

@see [URI | "FQSEN"] [<:type:>] [<description>]

Example:

@see \My\Class::myMethod() :alias: Description why this is an alias.

The relation type is considered to be an optional addition and may be omitted.
I also propose to create a separate list, or recommendations, for type names; this will help standardize and provide default meaning (comparable to http://www.iana.org/assignments/link-relations/link-relations.xhtml for the rel attribute of a link)

@dongilbert
Copy link

I like this concept and would support it. Are there any constraints on what :type: may be? Should there be constraints or just leave that up to the one writing the doc?

@mvriel
Copy link
Member Author

mvriel commented Aug 9, 2013

My suggestion would be to provide recommendations, as is done with the rel attribute for a link, and allow people to come up with their own. I would also suggest to maintain the recommendations outside of the standard in a living document so that those may change without affecting the actual PSR

@philsturgeon
Copy link

I'm all for this. Have something in the meta docs that explains some recommended types, but do not actually list anything (or reference them at all) in the main doc.

mvriel pushed a commit that referenced this issue Oct 11, 2013
removing the \Baz that does not exist in the path to finding Quux
@mvriel
Copy link
Member Author

mvriel commented Dec 4, 2013

I have altered the text to deprecate @link and describe @see in some more detail

@mvriel mvriel closed this as completed Dec 4, 2013
mvriel pushed a commit that referenced this issue Dec 9, 2014
mindplay-dk pushed a commit to mindplay-dk/fig-standards that referenced this issue Nov 28, 2016
…atement

Made the mission statement less wordy
ashnazg pushed a commit that referenced this issue Oct 2, 2018
ashnazg pushed a commit that referenced this issue Oct 2, 2018
Fix the EventInterface::stopPropagation() method
ashnazg pushed a commit that referenced this issue Oct 2, 2018
Added note about Liskov
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

No branches or pull requests

3 participants