commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

Discuss adding `:meta private:` to the doc string

Open bearomorphism opened this issue 7 months ago • 2 comments

We probably can try something like adding :meta private: to the doc string instead. Even though it's a sphinx thing, I think this should be sufficient

Originally posted by @Lee-W in https://github.com/commitizen-tools/commitizen/pull/1466#discussion_r2126744457

bearomorphism avatar Jun 04 '25 15:06 bearomorphism

it's more like choose between _func_name and :meta private:. We use both in Airflow. But Airflow uses Sphinx. can discuss a bit on what we want

Lee-W avatar Jun 05 '25 02:06 Lee-W

relates to https://github.com/commitizen-tools/commitizen/issues/1446

Lee-W avatar Jun 05 '25 02:06 Lee-W