AllenCell / AllenCell/endothelial-pipeline

Standardize docstrings to NumPy style

未關閉
#240 1 則留言 2 個 reaction 已指派 1 人 已被 @jessicasyu 認領 在 GitHub 檢視
size: 4 - large (1 - 4 hr) type: docs
主要語言
Python
星號
2
分支
0
PR 合併指標
30 天內沒有已合併 PR

描述

@benjijamorris @chantelleleveille @eeangelini @jcass11 @vianamp @pgarrison @mogres @SergeEParent

This is a proposal for a set of work to update and standardize the existing docstrings to use the [NumPy style](https://numpydoc.readthedocs.io/en/latest/format.html). I'm proposing this change for a couple reasons:

- supports consistency and readability
- enables automatic documentation generation from docstrings using Sphinx
- addresses a chunk of the `ruff` linting errors

I am happy to work on this if people are on board. This will not impact any workflows and I can do it in chunks to make reviewing easier.

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。