[wp-docs] Source file links for theme/plugin functions

Michael Beckwith michael.d.beckwith at gmail.com
Wed Nov 9 15:53:25 UTC 2011

Everyone that mentioned the fact that the source files change and that the
start of where each function is in the file are reason enough for me to
disregard this idea. That part is something that I completely didn't think
of. Was a noble idea, but WAY too much work with an ever evolving code-base.

On Wed, Nov 9, 2011 at 8:35 AM, Chip Bennett <chip at chipbennett.net> wrote:

> I think that the *default* source link should be to trunk (or *latest
> tag*, if that can be automated via generic filename link by the Codex);
> otherwise, this practice would create a TON of links that have to be
> updated with *every* WordPress major and point-release - and not just a tag
> filepath update, but also a verification that the linenumber itself hasn't
> changed.
> Also, you'd need to consider whether to link to the line that starts the
> function docblock, or to the line that starts the actual function
> definition (I'd prefer the latter, though consistency is more important
> than shed color on this point).
> Personally, I think time and effort would be far better spent ensuring
> that all function reference pages actually *have* source links to begin
> with.
> Chip
> On Wed, Nov 9, 2011 at 1:04 AM, Michael Beckwith <
> michael.d.beckwith at gmail.com> wrote:
>> I was wondering if it were feasible to link to the specific line where a
>> function is declared when saying "foo function is located in
>> wp-includes/bar.php". Instead of just linking to
>> http://core.trac.wordpress.org/browser/tags/3.2.1/wp-includes/bar.php,
>> go to the actual destination, and then copy/paste in the link + line number.
>> For example from get_userdata():
>> Current source link =
>> http://core.trac.wordpress.org/browser/tags/3.2.1/wp-includes/pluggable.php
>> Proposed source link =
>> http://core.trac.wordpress.org/browser/tags/3.2.1/wp-includes/pluggable.php#L94
>> The #L94 anchor pulls them straight to the start of the comment block for
>> the function.
>> Thoughts? Issues that I wasn't around for the first time someone thought
>> this up?
>> _______________________________________________
>> wp-docs mailing list
>> wp-docs at lists.automattic.com
>> http://lists.automattic.com/mailman/listinfo/wp-docs
> _______________________________________________
> wp-docs mailing list
> wp-docs at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-docs
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.automattic.com/pipermail/wp-docs/attachments/20111109/ca8ac82a/attachment.htm>

More information about the wp-docs mailing list