#91 Formatting of documentation for saxon-c/doc12/python/processor.html

[peter k]

The formatting for the documetation at https://www.saxonica.com/saxon-c/doc12/python/processor.html is inconsistent/incorrect.

For example, the following text-block contains information that appears to be formatting that's being ignored:

Property to get the short name of the licensed Saxon product edition. This represents the kind of configuration that has been created, rather than the software that has been installed; which depends on the license key supplied, as well as the software edition installed. :returns: the Saxon edition code: “EE”, “PE”, or “HE”. :rtype: str

I'm assuming that the ":rtype: str" text should be showing up on a separate line with "rtype" bolded. There are many such examples of this bad formatting in this page.

There are also cases in which tags are being displayed within the page:

eqname_to_clark_name(self, name, encoding=None)
Convert EQName string to clark name notation. :param name: The URI in EQName notation: Q{uri}local if the name is in a namespace.

...again, I'm assuming that the tags are intended to be formatting rather than to be displayed verbatim in the page.

[peter k]

Note that the tags are being interpreted as HTML in the report listed above, so it's not representative of what the end-user sees when looking at the documentation. They're seeing the tags rather than the formatting.

[Anonymous]

Thanks for the feedback, but Saxon left SourceForge behind many years ago. Support requests should be raised at http://saxonica.plan.io