Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrong info on API Documentation - ThreadedCommentForm #19

Closed
airstrike opened this issue Sep 30, 2010 · 1 comment
Closed

Wrong info on API Documentation - ThreadedCommentForm #19

airstrike opened this issue Sep 30, 2010 · 1 comment

Comments

@airstrike
Copy link

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
Copy link
Collaborator

vdboor commented May 15, 2013

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.

@vdboor vdboor closed this as completed May 15, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants