Clarify the meaning of "dynamic" for bindings
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by locating the “Feature Matrix: Bindings” table and the tutorial or binding documentation referenced in the issue. Confirm how C, C++, C dynamic, and C++ Dynamic bindings are described, then make the linking type and implicit dynamic behavior explicit. Done when a first-time user can distinguish static and dynamic loading from the documentation alone.
Written by the indexing model from the issue text.
Description
Just my experiences as a first time user of this library while I'm digging through the library itself, the tutorial, etc:
Currently, it is not obvious what the difference between C++ and C++ Dynamic bindings is (Same for C and C dynamic).
My first idea was that it could be related to the internal usage of dynamic_cast or something like that, but it seems like this is not the case.
Am I correct assuming that dynamic refers to the way the library is loaded (dynamically or statically linked)? The C++ dynamic bindings will have all the dlsym bits in it, whereas the normal C++ binding assumes static linking?
If that is correct, I propose the following changes:
- Add a new
Linking typecolumn in theFeature Matrix: Bindingstable that (eitherdynamicorstatic) - Clarify that most of the bindings are implicitly
dynamic- I think it's a bit confusing that C and C++ have variants without the suffix (static linking) and with thedynamicsuffix (dynamic linking), whereas the other language like Python or Pascal are just implicitly dynamic without the suffix.
If you're not using the library for the first time this may seem obvious, however to me as a first time library user it was not.
- Dominant language
- Go
- Stars
- 54
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Autodesk/AutomaticComponentToolkit
-
Autodesk/AutomaticComponentToolkit#226 · 5 comments · 3 reactions · 3 assignees ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Autodesk/AutomaticComponentToolkit#188 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
Autodesk/AutomaticComponentToolkit#183 · 1 comment ·
-
Autodesk/AutomaticComponentToolkit#162 · 1 reaction · 2 assignees ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
All issues in Autodesk/AutomaticComponentToolkit
Similar issues
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
kind/bug status/0-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
🤔 refinement needed
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
equinor/radix-operator#1979 ·