Autodesk / Autodesk/AutomaticComponentToolkit

Clarify the meaning of "dynamic" for bindings

オープン
#213 コメント 1 件 リアクション 2 件 担当者 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 type と暗黙的な dynamic behavior を明確にします。初めて使うユーザーがドキュメントだけで静的ロードと動的ロードを区別できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
c, cpp, python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。