Repository navigation
axis.convert_units is undocumented #18270
Description
Problem
https://matplotlib.org/api/_as_gen/matplotlib.axis.Axis.convert_units.html#matplotlib.axis.Axis.convert_units is pretty sparse for something that is the only way to get from units to floats...
Reacted by Michael Waskom
Activity
learner296 commentedon Aug 16, 2020
Hello @jklymak, I am an MS student in Computer Networks. I am interested to contribute to this issue.
Please let me know how to get started?
tacaswell commentedon Aug 17, 2020
@learner296 Glad you are interested in helping! The tack here is read the code, understand what this function is currently doing and document it.
https://matplotlib.org/api/units_api.html#module-matplotlib.units <- for a general explanation of how units were designed
https://matplotlib.org/api/_as_gen/matplotlib.artist.Artist.convert_xunits.html#matplotlib.artist.Artist.convert_xunits
https://matplotlib.org/api/_as_gen/matplotlib.artist.Artist.convert_yunits.html#matplotlib.artist.Artist.convert_yunits
https://matplotlib.org/gallery/units/bar_unit_demo.html https://matplotlib.org/gallery/units/annotate_with_units.html <- two example of them being used that may be informative to inspect.
jklymak commentedon Aug 17, 2020
@tacaswell @learner296 I do think this might be a bit beyond a first-issue, unless someone has struggled with the units system and knows what its history is. But of course if someone wants to dive in head first, they could try.
tacaswell commentedon Aug 17, 2020
I think having fresh eyes on the problem could help. There is nothing in there that is algorithmicly hard or subtle, it is "just" interconnected and under documented.
learner296 commentedon Aug 18, 2020
@tacaswell thank you for sharing the links. Now I can start.
learner296 commentedon Aug 25, 2020
@tacaswell I have read and try to understand but I have questions.
You said, understand the function and document it. Means write theoretically about the function?
can you explain this statement, "is pretty sparse for something that is the only way to get from units to floats...". Does he want more concise code?