HELP #30

New Issue

2020-06-16T15:47:22Z

phryk commented

2020-06-16 15:47:22 +00:00

(Migrated from rnd.phryk.net)

Originally from github issue:

Come up with a generic way of slapping help texts onto stuff.
Use peewee.Field.help_text in automagic Form classes (AddForm)[Now AutoForm].
Just add a help_text prop to form.fields.Field?

What about more than texts? Make it markdown-enabled?

Admin listing currently uses docstrings of Administerables. It would be nice to have those
in markdown, but is there a documentation system that supports markdown docstrings?

What other places would it make sense to render live inline documentation to?
(Sep 26, 2017)

form.fields.Fields can now be supplied with a help_text that is displayed in forms and storage.fields.Fields' help_text properties are used in automagically generated forms.

Still need to work on markdown based inline-documentation. And to write actual fucking documentation.
(Oct 2, 2017)

So next up should probably be adding help_text and verbose_name to all fields.
(Oct 2, 2017)

Originally from github issue: > Come up with a generic way of slapping help texts onto stuff. > Use peewee.Field.help_text in automagic Form classes (`AddForm`)[Now `AutoForm`]. > Just add a help_text prop to `form.fields.Field`? > > What about more than texts? Make it markdown-enabled? > > Admin listing currently uses docstrings of Administerables. It would be nice to have those > in markdown, but is there a documentation system that supports markdown docstrings? > > What other places would it make sense to render live inline documentation to? (Sep 26, 2017) > `form.fields.Field`s can now be supplied with a help_text that is displayed in forms and `storage.fields.Field`s' help_text properties are used in automagically generated forms. > > Still need to work on markdown based inline-documentation. And to write actual fucking documentation. (Oct 2, 2017) > So next up should probably be adding help_text and verbose_name to all fields. (Oct 2, 2017)

Sign in to join this conversation.