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

jsdoc-baseline to point to source at GitHub #178

Open
peter-lyons-kehl opened this issue Jun 16, 2016 · 0 comments
Open

jsdoc-baseline to point to source at GitHub #178

peter-lyons-kehl opened this issue Jun 16, 2016 · 0 comments
Milestone

Comments

@peter-lyons-kehl
Copy link

Hi Jeff,

An API is less likely to change than its implementation. Unless developers hook their commits to generating & publishing the API, the prettyfied source code gets out of date. Hence, readers of API would benefit, if for GitHub-hosted projects the API would link to prettyfied source code on GitHub. Could you add an option for that, please.

Additionally, users may want to run jsdoc-baseline on several related projects together. Therefore it should be configurable with a mapping {local-source-code-folder: GitHub URL prefix} to point across multiple GitHub projects.

Ideally, could you make the pretty-source-code pointing code extensible, so this could also work for BitBucket or GitLab.

(I looked at jsdoc-baseline, but I don't know where to start with this - whether in linkToLine() or elsewhere.)

@hegemonic hegemonic added this to the Future milestone Feb 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants