Skip to content

Reduce @see tags#248

Closed
jaspermdegroot wants to merge 1 commit into
devfrom
see-tags
Closed

Reduce @see tags#248
jaspermdegroot wants to merge 1 commit into
devfrom
see-tags

Conversation

@jaspermdegroot

Copy link
Copy Markdown
Member

No description provided.

@joemcgill

Copy link
Copy Markdown
Member

As I understand it, @see attributes should really only reference one function name. In the cases where both wp_get_attachment_sizes() and wp_calculate_image_sizes() are referenced, I would opt for the function being used, which is generally wp_get_attachment_sizes().

@jaspermdegroot

Copy link
Copy Markdown
Member Author

In the phpDoc manual I read "...unlimited number of values separated by commas". Nevertheless, I agree that just referring to wp_get_attachment_image_sizes() is sufficient. There we refer to `wp_calculate_image_sizes(). The same goes for the srcset functions.
I also noticed that we should wrap the function names in quotes or backticks.
Will update this PR.

Update: Actually we don't use @see in wp_get_attachment_image_sizes() to refer to wp_calculate_image_sizes() but I think it's fine to just refer to wp_get_attachment_image_sizes()

@jaspermdegroot jaspermdegroot force-pushed the see-tags branch 2 times, most recently from b39002a to d387d4e Compare November 16, 2015 17:45
@jaspermdegroot

Copy link
Copy Markdown
Member Author

Manually merged

@jaspermdegroot jaspermdegroot deleted the see-tags branch November 16, 2015 18:51
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