Autodesk / Autodesk/AutomaticComponentToolkit
Clarify the meaning of "dynamic" for bindings
- Vorherrschende Sprache
- Go
- Sterne
- 53
- Forks
- 26
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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 type` column in the `Feature Matrix: Bindings` table that (either `dynamic` or `static`)
- 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 the `dynamic` suffix (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.
Beitragsleitfaden
Rechercherichtung
Beginne damit, die Tabelle „Feature Matrix: Bindings“ und die im Issue referenzierte Tutorial- oder Binding-Dokumentation zu finden. Bestätige, wie C-, C++-, C dynamic- und C++ Dynamic-Bindings beschrieben werden, und mache anschließend den Linking-Typ sowie das implizite dynamische Verhalten explizit. Die Aufgabe ist erledigt, wenn ein Erstbenutzer allein anhand der Dokumentation zwischen statischem und dynamischem Laden unterscheiden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- c, cpp, python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100