doctests should not be used in regular documentation outside the orm

[simon]

The forms docs for example really shouldn't be using doctest style.

[Marc Fargas]

Could the submiter please elaborate a bit more the Description, for us non-native English speakers! I understood:

"""The Examples in the Forms documentations shouldn't be using Doctest style."""

Am I right? In that case I doubt that's really a bug, doctests are used for documentation because they exemplify things, (that is: You type This, You get That).

[Malcolm Tredinnick]

This ticket doesn't really make sense. Forbidding examples in docstrings would be bad style. If there are places where the examples are confusing, rather then enlightening, or drown out the real description, patches to clarify/remove would be useful. If you're worried that people might think those examples are actually run as tests, a patch to contributing.txt or a patch to the testing framework to run the doctests would be useful.

But the general statement in the ticket description wouldn't be a good road to go down. Docstrings should be as clear as possible and doctest happened to choose (re-use) a style that was particularly clear. Using that style without it being a doctest is fine.