Giter Site home page Giter Site logo

Fix documentation syntax about pyuniprot HOT 3 CLOSED

cebel avatar cebel commented on July 2, 2024
Fix documentation syntax

from pyuniprot.

Comments (3)

cebel avatar cebel commented on July 2, 2024

Can you please specify a reference to this style of documentation. Because this ends up with ugly Sphinx documentation as:

or tuple[str] name (str)

from pyuniprot.

cebel avatar cebel commented on July 2, 2024

Found it
https://pythonhosted.org/an_example_pypi_project/sphinx.html#function-definitions

but it's different, should be:

    :param name: UniProt entry name(s)
    :type name: str or tuple[str]

from pyuniprot.

cebel avatar cebel commented on July 2, 2024

See Sphinx doc...

http://www.sphinx-doc.org/en/stable/domains.html

:type point: tuple(float, float)
:type point: tuple[float, float]

tuple can use () or []. I like more () because more intuitive for tuples

Will change query docs now to:

:param name: UniProt entry name(s)
:type name: str or tuple(str) or None

from pyuniprot.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.