[Bug 6911] Include xs:documentation in xs:assert examples

http://www.w3.org/Bugs/Public/show_bug.cgi?id=6911


Michael Kay <mike@saxonica.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |mike@saxonica.com




--- Comment #1 from Michael Kay <mike@saxonica.com>  2009-05-15 09:08:09 ---
I've got slightly mixed feelings about this. This might encourage an
expectation that the content of the documentation is suitable text for use in
an error message. If everyone shares that expectation, that's probably good.
But some people might not share the expectation, and write

<xs:documentation>
  TODO: This catches some illegal inputs, but leaves a security hole if
  the user specifies "-17".
</xs:documentation>

It might be better also to add a Note: "Schema authors are encouraged to write
the content of the documentation element within an assertion in a form suitable
for use in an error message directed at authors of instance documents that fail
to satisfy the assertion." But then we beg questions about localisation. 

On balance, yes, let's do it. If we just put it in an example with no
recommendations, we can leave the community to develop conventions.


-- 
Configure bugmail: http://www.w3.org/Bugs/Public/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.

Received on Friday, 15 May 2009 09:08:19 UTC