Attribute description enhancement - proof of demo #4604
Conversation
Codecov ReportBase: 90.77% // Head: 90.80% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #4604 +/- ##
==========================================
+ Coverage 90.77% 90.80% +0.03%
==========================================
Files 41 41
Lines 8771 8781 +10
==========================================
+ Hits 7962 7974 +12
+ Misses 809 807 -2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| @@ -2,6 +2,9 @@ const AStr = AbstractString | |||
| const ColorType = Union{Symbol,Colorant,PlotUtils.ColorSchemes.ColorScheme,Integer} | |||
| const TicksType = Union{AVec{Real},Tuple{AVec{Real},AVec{AStr}},Symbol} | |||
|
|
|||
| link_histogram = "[`histogram`](https://docs.juliaplots.org/stable/api/#Plots.histogram-Tuple)" | |||
There was a problem hiding this comment.
I think this is a good idea, although this is not really aimed toward being maintainable.
There was a problem hiding this comment.
an option would be to insert some sort of tag like e.g. [:histogram:] and then replace that with the link when building the ducumentation.
Ideally that would then end up in the docstring as well, but I don't see a way to make that happen
|
I don't want to block any good effort towards having cleaner and enhanced docs. So @Ininterrompue tell us when you want this merged (and when you think it is ready). @BeastyBlacksmith, does this looks good to you ? |
|
In its current state it doesn't produce usable docs. Though its heading in a good direction. |
Enhances descriptions for the following histogram-related attributes as a proof of demonstration:
binsshow_empty_binsweightsTwo issues:
\n(and also present in the current descriptions) - help wanted to hide these