Opened 7 years ago

Closed 6 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 Branch: branches/span-classes-2514
(diff, github, buildbot, log)
Author: thijs Launchpad Bug:

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 6 years ago by exarkun

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 6 years ago by thijs

  • Cc thijs added
  • Keywords documentation added
  • Owner changed from spiv to thijs
  • Status changed from new to assigned

comment:3 Changed 6 years ago by thijs

  • author set to thijs
  • Branch set to branches/span-classes-2514

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

comment:4 Changed 6 years ago by thijs

  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

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 follow-up: Changed 6 years ago by exarkun

  • Keywords review removed
  • Owner set to thijs

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 6 years ago by thijs

  • Keywords review added
  • Owner thijs 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 6 years ago by exarkun

  • Keywords review removed
  • Owner set to thijs

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

comment:8 Changed 6 years ago by thijs

  • Resolution set to fixed
  • Status changed from new to closed

(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 3 years ago by <automation>

  • Owner thijs deleted
Note: See TracTickets for help on using tickets.