bug#21448: 25.0.50; `unicode-property-table-internal' in Elisp manual

[Drew Adams]

> OK, then please provide more details about what information should be
> added to explain the example.  I think the code is straightforward, it
> just loops over a char-table, which is clear from the code.  What is
> missing?
> 
> I really need that help, if you want any changes.  Just repeating that
> the example is not clear enough doesn't cut it.

Thank you for looking into this.  Let me start by saying that the
first part of the node, which explains categories, is very clear
and well put.

I think that all that is missing wrt explaining the example is to
say (in this node) what `uniprop-table' is here, and why and how
it is used.

A minor help might be to rename variable `uniprop-table' to, say,
`bidi-class-table' or `bidi-table'.  I don't know enough about bidi
or `unicode-property-table-internal' to really know what this
char-table is: what its char entries are mapped to.  Something to
do with character property `bidi-class' (a property I am  not
familiar with).  Maybe it means that a char entry is mapped by the
table to all of the chars in its bidi class?

These bidi things are clear to you, but not necessarily to a
reader of this node.  A few words about this might help.

If the use of `bidi-class-table' is clarified (explained a bit)
then I think the example becomes clear.  You iterate over
`bidi-class-table', and for any char that the table maps to R, AL,
or RLO, you modify that same char's entry in the new `category-table',
so that the char gets mapped in `category-table' to the character
?R (which represents its category) .

It might also help if function `modify-category-entry' were
presented before this example, but that's not critical.

HTH.  Feel free to close the bug if you disagree about adding
some explanation here.  (Well, it's already closed, I guess.)