Add a class for svg strings #2377
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2377 +/- ##
=======================================
Coverage 93.25% 93.25%
=======================================
Files 28 28
Lines 26864 26868 +4
Branches 1229 1230 +1
=======================================
+ Hits 25053 25057 +4
Misses 1778 1778
Partials 33 33
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
hyanwong
force-pushed
the
svg-class
branch
2 times, most recently
from
59ddc22 to
0c2b72a
Compare
|
The functionality is not actually documented in the |
python/tskit/drawing.py
Outdated
| return self.plot_min - (y - self.min_time) * y_scale | ||
|
|
||
|
|
||
| class _svg_string(str): |
There was a problem hiding this comment.
Can we use SVGString? As a class name it has to be capitalised.
There was a problem hiding this comment.
Oh yes, very good point. If we think of it a an "internal use" class do we want a prefix underscore, _SVGString or are we happy that it's sort of public?
There was a problem hiding this comment.
Without the underscore as it is returned by the API.
There was a problem hiding this comment.
Done, and a bit of documentation added.
|
Docs failing because |
|
As this is being returned by the public API it should probably be doc'd under https://tskit.dev/tskit/docs/stable/python-api.html#miscellaneous-classes |
Oh, very good call. Done. |
2 participants
As discussed in https://github.com/tskit-dev/tskit/discussions/2376