obmarg / kazan

Kubernetes API client for Elixir
https://hex.pm/packages/kazan
MIT License
140 stars 35 forks source link

Autolink module/api names in documentation #38

Open obmarg opened 6 years ago

obmarg commented 6 years ago

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.