search

RDFLib / pyLDAPI

A very small module to add Linked Data API functionality to a Python Flask installation
BSD 3-Clause "New" or "Revised" License
41 stars 11 forks source link

Documentation in Sphinx #8

Closed edmondchuc closed 5 years ago

edmondchuc commented 5 years ago

Most of the changes in the source code non-functional such as changes in the docstrings, etc.

There is one functional change in pyldapi.Renderer._render_alternates_view(). It has been changed to pyldapi.Renderer.render_alternates_view(). If this gets accepted, then we will also need to add pyldapi.Renderer._render_alternates_view() back in to not break existing projects.

The reason for the change is, "I will be looking into refactoring parts of the pyLDAPI – more specifically the current requirement of using pyldapi.Renderer._render_alternates_view() for custom Renderer classes. If it’s required to be called manually, it should ideally drop the prefix underscore. Otherwise see if it’s possible to refactor it to the behaviour of the RegisterRenderer class where it’s handled automatically by the tool (I think unlikely after having some time thinking about it)."

ashleysommer commented 5 years ago

@edmondchuc Should some or all of these changes be merged into master? I know the render_alternates_view() should, but I'm guessing all of the in-code docs should be merged into master too?

edmondchuc commented 5 years ago

@ashleysommer The docs are currently on the 'docs' branch since I was testing documentation deployment to Read the Docs. Once I double check that I have made no functional changes, I will make a pull request to master branch. I've changed render_alternates_view() back to _render_alternates_view() since we probably need to keep it compatible with existing projects.

I also drafted a possible solution to the Renderer class here: https://github.com/RDFLib/pyLDAPI/issues/9