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

docgen: add source URLs to the default formatter #14341

Closed
oandregal opened this issue Mar 8, 2019 · 3 comments
Closed

docgen: add source URLs to the default formatter #14341

oandregal opened this issue Mar 8, 2019 · 3 comments
Labels
[Priority] Low Used to indicate that the issue at hand isn't a top priority to address and can be handled later [Tool] Docgen /packages/docgen [Type] Bug An existing feature does not function as intended

Comments

@oandregal
Copy link
Member

oandregal commented Mar 8, 2019

As of #14656 the generated docs no longer include the URL to the export statement.

These are some problems we faced:

@oandregal oandregal changed the title docgen: add absolute URL docgen: make code links point to an absolute URL Mar 8, 2019
@oandregal oandregal added the [Tool] Docgen /packages/docgen label Mar 8, 2019
@oandregal oandregal changed the title docgen: make code links point to an absolute URL docgen: add source URLs to the default formatter Mar 27, 2019
@aduth
Copy link
Member

aduth commented Mar 28, 2019

If I'm being honest, I don't know that I long for the URL to return. I think it could be argued that it provides some value, but also a fair amount of pain in the line-number-only revisions it has a tendency to introduce to a README file in the course of a pull request.

@oandregal
Copy link
Member Author

I share that sentiment. One thing that is growing on me is that its usefulness depends on context:

  • I'm all in for having the URL in the handbook. That's something that you navigate with the browser, and you may want to have a quick look at the implementation.

  • README files that are collocated with code: it's nice, but doesn't provide the same value.

Right now, both use the same README. But there is no reason they should (specially if/when we consider moving the symbols to developer.wordpress.org).

I don't feel the urge to prioritize this.

@aduth aduth added the [Priority] Low Used to indicate that the issue at hand isn't a top priority to address and can be handled later label Apr 8, 2019
@jordesign jordesign added the [Type] Bug An existing feature does not function as intended label Aug 4, 2023
@oandregal
Copy link
Member Author

I'm triagging issues we don't plan to tackle. We can reopen if it regains interest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Priority] Low Used to indicate that the issue at hand isn't a top priority to address and can be handled later [Tool] Docgen /packages/docgen [Type] Bug An existing feature does not function as intended
Projects
None yet
Development

No branches or pull requests

3 participants