search

honzakral / django-threadedcomments

django-threadedcomments is a simple yet flexible threaded commenting system for Django.
BSD 3-Clause "New" or "Revised" License
623 stars 164 forks source link

Wrong info on API Documentation - ThreadedCommentForm #19

Closed airstrike closed 11 years ago

airstrike commented 14 years ago

The markup field on ThreadedCommentForm's is not required. I've created a form with just {{ form.comment }} and the markup defaults to plaintext (which is imho the expected behavior).

My advice is to change the docs to reflect the form's actual behavior rather than requiring markup.

You can find examples in the documentation links below:

API Documentation (http://tinyurl.com/django-tc-docs1)

ThreadedCommentForm

Simply includes two fields: comment, and markup.

(...) _markup: _required* The type of markup that the comment is using. This may be easily overridden in a subclass to become a HiddenInput, if the user is not to be given a choice of markup options.*

More documentation (http://tinyurl.com/django-tc-docs2)

Common Fields

(...)

The following fields deal with the actual content of the comment itself:

(...)

:markup [IntegerField]: required The format of the comment. Values may be MARKDOWN, TEXTILE, REST, PLAINTEXT. This can be used for display purposes when deciding how to format the comment for viewing.

vdboor commented 11 years ago

Hi, I'm sorry this ticket has been open so long. I'm closing it, as the markup field no longer applies to the latest version.