lambdamusic / Ontospy

Python library and command-line interface for inspecting and visualizing RDF models aka ontologies.
http://lambdamusic.github.io/Ontospy/
MIT License
219 stars 52 forks source link

Fix tables markdown for classes in gendoc #137

Open fmeynadier opened 5 months ago

fmeynadier commented 5 months ago

Hello,

Thanks for this useful tool. This pull request proposes an update of the markdown template for classes in gendoc, with which I had some issues.

The first commit is simply removing some leading spaces that caused pandoc (as well as the github markdown renderer) to consider the subsequent HTML-formatted table as a code block, hence escaping the html tags and special characters, and causing the actual html code to be displayed instead of a table when rendered as html.

Then I tried to switch to the usual way to encode tables in markdown, thus avoiding the HTML tags. I had to tweak the jinja tags to avoid newlines that broke the markdown table format.

Last I noticed missing parenthesis after the "description" item, causing the reference to the function appear instead of the returned value.

I hope you will find these suggestions useful.