Opened 11 years ago

Closed 10 years ago

#2514 defect closed fixed (fixed)

Documentation bug in the list of possible <span/> classes

Reported by: edwards Owned by:
Priority: normal Milestone:
Component: lore Keywords: documentation
Cc: Thijs Triemstra Branch: branches/span-classes-2514
branch-diff, diff-cov, branch-cov, buildbot
Author: thijs

Description

In "Elements and their uses", the "span" element is listed as having a "span" class. e.g.

<span class="span" value="a!b!c"/>

Shouldn't that be "index"?

<span class="index" value="a!b!c"/>

Change History (9)

comment:1 Changed 10 years ago by Jean-Paul Calderone

Indeed it should. This document has some other problems as well. For example, the formatting of the information of what attributes have special meaning for what elements is terrible. Furthermore, the information is not as accurate as it could be. For example, any element can have the index attribute, not just spans.

comment:2 Changed 10 years ago by Thijs Triemstra

Cc: Thijs Triemstra added
Keywords: documentation added
Owner: changed from spiv to Thijs Triemstra
Status: newassigned

comment:3 Changed 10 years ago by Thijs Triemstra

author: thijs
Branch: branches/span-classes-2514

(In [24884]) Branching to 'span-classes-2514'

comment:4 Changed 10 years ago by Thijs Triemstra

Keywords: review added
Owner: Thijs Triemstra deleted
Status: assignednew

Moved the elements into a table which is easier to read. Couldn't find the other issues described here, putting it up for review.

comment:5 Changed 10 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Thijs Triemstra

The other issue is still present: the span element is documented as being allowed to have a span attribute which results in some interaction with the resulting term index. The correct attribute name for this is index.

comment:6 in reply to:  5 Changed 10 years ago by Thijs Triemstra

Keywords: review added
Owner: Thijs Triemstra deleted

Replying to exarkun:

The other issue is still present: the span element is documented as being allowed to have a span attribute which results in some interaction with the resulting term index. The correct attribute name for this is index.

Ah so it was that simple :) Fixed in r24887

comment:7 Changed 10 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Thijs Triemstra

There's some trailing whitespace in the new table markup. Otherwise this looks good. Please strip the whitespace and merge.

comment:8 Changed 10 years ago by Thijs Triemstra

Resolution: fixed
Status: newclosed

(In [24915]) Merge span-classes-2514: Correct documentation bug in the list of possible <span/> classes ('index' instead of 'span'). Moved elements into table.

Author: thijs Reviewer: exarkun Fixes: #2514

comment:9 Changed 7 years ago by <automation>

Owner: Thijs Triemstra deleted
Note: See TracTickets for help on using tickets.