zeitgeist icon indicating copy to clipboard operation
zeitgeist copied to clipboard

Remove docstrings from parameter definitions in `runtime/*/params.rs`

Open maltekliemann opened this issue 2 years ago • 3 comments

We're double/triple/quadruple-booking the docstrings of the parameters in the runtime definitions. This is unmaintainable and quite frankly very hard to read. Let's keep the docstrings for parameters in the pallet definitions.

maltekliemann avatar Dec 15 '22 12:12 maltekliemann

This is a won't fix. We want the docstrings to be there so that each runtime is documented separately. I'm leaving this open because the double/triple/quadruple-booking that we're doing to achieve this is not good. If you know a way of solving this problem, let us know.

maltekliemann avatar Jan 03 '23 13:01 maltekliemann

We want the docstrings to be there so that each runtime is documented separately

Then just document inside each runtime what is actually different. And don't document what already is documented inside the pallet configuration parameter doc string.

Chralt98 avatar Nov 10 '23 14:11 Chralt98

Then just document inside each runtime what is actually different.

This.

maltekliemann avatar May 03 '24 17:05 maltekliemann