Node Text line width documentation unclear

[ethanmizuno16]

When working with SBMLDiagrams API, the documentation given for setNodeTextLIneWidth is unclear on what is being changed. All that is given is "Set the node text line width for a node of given id" with the arguments: id: str-node id. txt_line_width: float-node text line width. alias: int-alias node index: 0 to number of alias nodes -1.

I feel like the common person who tries to use the API will not understand what this means or what its physically changing unless they physically compare two images.

[SunnyXu]

The node text line width describes the text line width of the node, which changes the value of the stroke width of the node TEXTGLYPH. This might not be observable in image, but you could look into the exported SBML file and confirm what has changes.

[hsauro]

Ethan, can you give an example of the documentation you'd like to see used?

H

On Thu, Sep 21, 2023 at 7:30 PM ethanmizuno16 @.***> wrote:

When working with SBMLDiagrams API, the documentation given for setNodeTextLIneWidth is unclear on what is being changed. All that is given is "Set the node text line width for a node of given id" with the arguments: id: str-node id. txt_line_width: float-node text line width. alias: int-alias node index: 0 to number of alias nodes -1.

I feel like the common person who tries to use the API will not understand what this means or what its physically changing unless they physically compare two images.

— Reply to this email directly, view it on GitHub https://urldefense.com/v3/__https://github.com/SunnyXu/SBMLDiagrams/issues/85__;!!K-Hz7m0Vt54!h2KLAdLTZAHiDT_VSTcmfubyECYwVkuM4_vxdxoZg2v3C7eOviXRgLBIprQh4oTHK17Dku3KhJscvFokSVRLbYMlRDhJSg$, or unsubscribe https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AAIBSDXTDDY2G5V4PERQYPTX3TZ35ANCNFSM6AAAAAA5CNTHMA__;!!K-Hz7m0Vt54!h2KLAdLTZAHiDT_VSTcmfubyECYwVkuM4_vxdxoZg2v3C7eOviXRgLBIprQh4oTHK17Dku3KhJscvFokSVRLbYMg0ytMwg$ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

-- Herbert Sauro, Professor Director: NIH Center for model reproducibility University of Washington, Bioengineering 206-685-2119, www.sys-bio.org, http://reproduciblebiomodels.org/ Mobile: 206-880-8093 @.*** Books: http://books.analogmachine.org/

[ethanmizuno16]

I think maybe just being more descriptive in the main description and adding in that it changes the value of the stroke width of the TEXTGLYPH will be more helpful to the user.