Autodesk / Autodesk/AutomaticComponentToolkit

Clarify the meaning of "dynamic" for bindings

未关闭
#213 1 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Go
星标
53
派生
26
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

打开贡献指南

调研方向

首先定位“Feature Matrix: Bindings”表以及 issue 中引用的教程或 binding 文档。确认其中如何描述 C、C++、C dynamic 和 C++ Dynamic bindings,然后明确 linking 类型和隐式 dynamic 行为。当首次使用的用户仅凭文档就能区分静态加载和动态加载时,即可完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
c, cpp, python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。