Autodesk / Autodesk/AutomaticComponentToolkit
Clarify the meaning of "dynamic" for bindings
- Langage dominant
- Go
- Étoiles
- 53
- Forks
- 26
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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 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.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par localiser le tableau « Feature Matrix: Bindings » ainsi que le tutoriel ou la documentation des bindings référencés dans l’issue. Vérifiez comment sont décrits les bindings C, C++, C dynamic et C++ Dynamic, puis rendez explicites le type de linking et le comportement dynamique implicite. Le travail est terminé lorsqu’un nouvel utilisateur peut distinguer le chargement statique du chargement dynamique à partir de la documentation seule.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- c, cpp, python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100