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

Autolink module/api names in documentation #38

Open
obmarg opened this issue Mar 22, 2018 · 0 comments
Open

Autolink module/api names in documentation #38

obmarg opened this issue Mar 22, 2018 · 0 comments

Comments

@obmarg
Copy link
Owner

obmarg commented Mar 22, 2018

An excerpt from Kazan.Apis.Apps.V1beta1.ControllerRevision:

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision

In this sample, it'd be ideal if ControllerRevision was quoted, and if apps/v1beta2/ControllerRevision was converted into Kazan.Apis.Apps.V1beta2.ControllerRevision so that ExDoc would automatically link to the replacement module.

Not sure how hard this would be, but it seems like it'd be worth it.

It might also be possible for some names of modules that aren't fully scoped to somehow become links. Though this might need some work done in ExDoc. As repeating the full module path every time in a sentence is going to become tiresome.

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

1 participant