Skip to content

cleaning comments, docstrings, etc #54

@H4ppy-04

Description

@H4ppy-04
  • Cleanup doc-strings
  • Clean comments - grammar, syntax etc, adding comments when needed

Note Global doc-string syntax taken from requests' open source library.

def get(url, params=None, **kwargs):
    r"""Sends a GET request.

    :param url: URL for the new :class:`Request` object.
    :param params: (optional) Dictionary, list of tuples or bytes to send
        in the query string for the :class:`Request`.
    :param \*\*kwargs: Optional arguments that ``request`` takes.
    :return: :class:`Response <Response>` object
    :rtype: requests.Response
    """

    return request("get", url, params=params, **kwargs)

Sample of requests doc-string conventions.

Metadata

Metadata

Assignees

Labels

code-cleanupcleaning up messy or redundant code.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions