Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

関数とパラメーターに説明のリンク追加 #534

Merged

Conversation

tsuchiyama-araya
Copy link
Collaborator

@tsuchiyama-araya tsuchiyama-araya commented Dec 23, 2024

Copy link
Collaborator

@itutu-tienday itutu-tienday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 現時点では、指摘事項はall resolevedを確認
  • なおドキュメントへのリンクURLは仮状態と思われるため、Approve は一旦保留
    • ドキュメント担当者と URLを決定の上、コードへ反映してください

…-description
@tsuchiyama-araya
Copy link
Collaborator Author

こちらのPRがCloseしたら、こちらのPRもCloseします。
#466

@@ -26,6 +29,8 @@ export const AlgorithmParamForm = memo(function AlgorithmParamForm() {
selectAlgorithmParamsKeyList(nodeId),
arrayEqualityFn,
)
const formattedAlgoName = algoName.toLowerCase().replace(/_/g, "-")
const parameterUrl = `https://optinist.readthedocs.io/en/latest/specifications/algorithm_nodes.html#${formattedAlgoName}`
Copy link
Collaborator

@itutu-tienday itutu-tienday Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

リンク成功のテストを行って下さい
※少し確認してみたところ、リンク切れが多数ありそうです(リンク先にコンテンツはあるようです)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

こちら対応できました。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

すべて確認していませんが、複数件のリンク切れがまだあるようです。
→ lccd_cell_detection, cnmf_multisession, ...

すべてのNode Paramのリンク成功を、再チェックしてください。

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@itutu-tienday
こちら対応と確認できました。
お手数ですが、ご確認お願いいたします。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

まだリンク切れがあるようです

roi_fluo_from_hdf5

※次回以降の同様の対応では、チェック完了のエビデンスをシェアしてください。

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

そちらは、間違ってないかと思います。
一番下のページなので、もうそれ以上いきません。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

なるほど、roi_fluo_from_hdf5ですね。
こちらは、まだ記載されていないのですが、こちらのブランチで対応したほうが良いのでしょうか?
また、DocsとParamsリンクのリリースは同時で行いますか?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ドキュメントは用意しないのですか?
Node作成者・ドキュメント編集者間で、調整してください。

@@ -26,6 +29,8 @@ export const AlgorithmParamForm = memo(function AlgorithmParamForm() {
selectAlgorithmParamsKeyList(nodeId),
arrayEqualityFn,
)
const formattedAlgoName = algoName.toLowerCase().replace(/_/g, "-")
const parameterUrl = `https://optinist.readthedocs.io/en/latest/specifications/algorithm_nodes.html#${formattedAlgoName}`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

@itutu-tienday itutu-tienday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

まだリンク切れが確認されますが、1箇所のみのため、修正のmergeを優先し、approveします。
上記リンク切れについて、ドキュメント更新担当者と調整の上、最終的にリンク切れを解消しておいてください。

…-description
@tsuchiyama-araya tsuchiyama-araya merged commit 28e39c5 into develop-main Mar 3, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[No.132]Display of function/parameter description
2 participants