IP addresses definitely don't belong in plain text since they're a
value... so that option can be ruled out.
Between the other two options, I'm torn: I think that using the
``"some_value"`` notation (quotes inside an inline code block) breaks
the visual flow for what's usually an obvious distinction, but it
could also be argued that it's technically correct when you're
representing a string value. The quotes also serve to differentiate
string values from attributes, methods, and other cross-ref targets
which are automatically formatted similarly but without the quotes.
If you hadn't raised the question, I would have used the double
backtick without the quotes. However, thinking about it now I'm
undecided...
Who else would like to weigh in? ;-)
- Gabriel
On Nov 12, 4:55 pm, Łukasz Rekucki <[email protected]> wrote:
> Hi,
>
> While updating a patch for ticket #7735 I noticed that docs are
> inconsistent about how IP addresses should be written. Some are
> surrounded with double back quotes (``) and some are plain text[1].
> After a quick search I also found a quoted one[2].
>
> Is there a preferred way of writing IP addresses in the docs ? Maybe
> we could add a one to contributor docs.
>
> [1]:http://docs.djangoproject.com/en/dev/ref/django-admin/?from=olddocs#r...
> [2]:http://docs.djangoproject.com/en/dev/ref/models/fields/#ipaddressfield
>
> --
> Łukasz Rekucki
--
You received this message because you are subscribed to the Google Groups
"Django developers" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-developers?hl=en.
