Skip to content

Conversation

@jeanine18
Copy link

Changes

  • Align parameter names in Args: with function signatures
  • Enforce name (type): description (add missing :)
  • Fix minor type tokens (e.g., bookbool)
  • Add missing one-line descriptions
  • Remove doc-only params: drop Args: entries not in the signature.

@bdemchak
Copy link
Collaborator

Thank you very much for proposing all of these ... I can see their value and am eager to integrate them. Note that it's likely that most of these changes apply to the R library, too.

In looking these changes over, I have concerns about parameter descriptions that have multiple lines (e.g., style_auto_mappings.py lines 655, 676, and 697). Generally, I use the style of indenting follow-on lines because I'm not so sure that multiple lines will be interpreted properly by ReadTheDocs when it generates a manual. Also, indented follow-on lines improves readability.

For example:

        base_url (str): Ignore unless you need to specify a custom domain,
            port or version to connect to the CyREST API. Default is http://localhost:1234
            and the latest version of the CyREST API supported by this version of py4cytoscape.

Instead of:

        base_url (str): Ignore unless you need to specify a custom domain, port or 
        version to connect to the CyREST API. Default is http://localhost:1234 
        and the latest version of the CyREST API supported by this version of 
        py4cytoscape.

I have a similar concern with parameters that can take multiple types ... I'm not sure that "new_x_locations(list or int or float)" will pass ReadTheDocs.

Before we merge these, would you mind changing the indentation on the multi-line parameter descriptions? If you'll do that, then I'll merge and see what ReadTheDocs does with the "or" for parameters that have multiple types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants