karamba3d / K3D_NightlyBuilds

Nightly build versions of Karamba3d
https://karamba3d.com
25 stars 2 forks source link

BUG: Better documentation or summaries for methods. #60

Open JaakkoArokoskiRF opened 1 year ago

JaakkoArokoskiRF commented 1 year ago

We need better documentation (method summaries) for methods or for code. It's very unclear what units to use or values to pass where.

karamba3d commented 1 year ago

Dear Jaakko,

the units can be set by the user. There are the UnitsConversionFactories (see here: https://scripting.karamba3d.com/2.-scripting/2.2-data-retrieval-from-models) which are used to convert units. This is the reason why they are normally mentioned in the method documentation. Exceptions exist for e.g. creating cross sections. Does this answer help you?

best, Clemens @.**@.>

Karamba3D Clemens Preisinger A-1010 Vienna www.karamba3d.comhttps://www.karamba3d.com LinkedInhttps://www.linkedin.com/company/karamba3d | Instagramhttps://www.instagram.com/karamba3d/ | Youtubehttps://www.youtube.com/c/karamba3d


From: JaakkoArokoskiRF @.> Sent: Wednesday, March 1, 2023 8:10 AM To: karamba3d/K3D_NightlyBuilds @.> Cc: Subscribed @.***> Subject: [karamba3d/K3D_NightlyBuilds] BUG: Better documentation or summaries for methods. (Issue #60)

We need better documentation (method summaries) for methods or for code. It's very unclear what units to use or values to pass where.

— Reply to this email directly, view it on GitHubhttps://github.com/karamba3d/K3D_NightlyBuilds/issues/60, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AHGHKP23NIOHN42GELMK4VDWZ3Y55ANCNFSM6AAAAAAVLVFXIY. You are receiving this because you are subscribed to this thread.Message ID: @.***>