[liblouis-liblouisxml] Re: liblouisutdml documentation

  • From: "Michael Whapples" <dmarc-noreply@xxxxxxxxxxxxx> (Redacted sender "mwhapples@xxxxxxx" for DMARC)
  • To: liblouis-liblouisxml@xxxxxxxxxxxxx
  • Date: Wed, 18 Jun 2014 09:24:32 +0100

May be this is one of my fears, there is simply a lack of knowledge on liblouisutdml.


I seem to be the main one working on it, and I feel may be my own knowledge of exact behaviours of liblouisutdml are based on what I can gather from examining source code. However examining source code feels a dangerous thing to be purely relying on, there are basically no comments explaining the intent of the code, the code at some points is not very clear as to what it is doing (sometimes flow and sometimes due to the use of static variables), a lack of documentation explaining what should happen and no tests showing what the intended behaviour is. Just running the code also is not always useful as results can be inconsistant (eg. different results depending on output format selected) and one can never quite be sure if something which happens is intended or actually a bug as it cannot be cross referenced against any other source of information.

Who feels they have knowledge to document liblouisutdml?

Michael Whapples
On 18/06/2014 08:46, Christian Egli wrote:
On 06/17/2014 07:15 PM, Michael Whapples (Redacted sender mwhapples@xxxxxxx for DMARC) wrote:

So we need to ask the question why is the documentation not being
updated and what can be done to improve the situation?

What is the case for others involved in liblouisutdml (either simply
using it or may be developing it) as to why they do not update the
documentation?

I'd be happy to help with the documentation, but since I don't know the inner workings (at least of liblouisutdml) I do not feel comfortable adding content. If somebody knowledgeable provides the content I'd be happy to work it in.

Thanks
Christian


For a description of the software, to download it and links to
project pages go to http://www.abilitiessoft.com

Other related posts: