keras-team/keras-autodoc

Can "function" and "class" suffixes in docs headers be removed or become optional?

leonoverweel opened this issue · 1 comments

Currently Keras Autodoc appends the word "class" to the names of classes in their docs headers (example in our Larq docs, larq.layers.QuantDense becomes "QuantDense class") and "function" to the names of functions (example).

We think this adds a bit of unnecessary visual noise/clutter (see larq/docs#118), so I was wondering if this is something we can make optional or remove altogether? I'd be happy to make a PR myself, just wanted to check in before I do. :)

I'd be in favor of removing them altogether :) sometimes, we want users to use a function as a class constructor and sometimes there are classes that look like functions (being lowercase). So it's confusing if we explicitly say what they are in the docs.