RIT-NTNU-Bachelor / OpenCV_Server

Python server that sends coordinates of the detected face over UDP.
https://rit-ntnu-bachelor.github.io/OpenCV_Server/
MIT License
1 stars 0 forks source link

Docs: same documenting style for function in OpenCV server #40

Closed KjetilIN closed 6 months ago

KjetilIN commented 6 months ago

What?

Make the documentation style for all the functions the same.

KjetilIN commented 6 months ago

Going to work on this on the 19th of April. Will take some time, but is required for high quality code.

KjetilIN commented 6 months ago

The order is:

Random example:

 def __init__(
            self, authority, validate_authority=None, cache=None,
            api_version='1.0', timeout=None, enable_pii=False, verify_ssl=None, proxies=None):
        '''Creates a new AuthenticationContext object.

        By default the authority will be checked against a list of known Azure
        Active Directory authorities. If the authority is not recognized as 
        one of these well known authorities then token acquisition will fail.
        This behavior can be turned off via the validate_authority parameter
        below.

        :param str authority: A URL that identifies a token authority.
        :param bool validate_authority: (optional) Turns authority validation 
            on or off. This parameter default to true.
        :param TokenCache cache: (optional) Sets the token cache used by this 
            AuthenticationContext instance. If this parameter is not set, then
            a default is used. Cache instances is only used by that instance of
            the AuthenticationContext and are not shared unless it has been
            manually passed during the construction of other
            AuthenticationContexts.
        :param api_version: (optional) Specifies API version using on the wire.
            Historically it has a hardcoded default value as "1.0".
            Developers are now encouraged to set it as None explicitly,
            which means the underlying API version will be automatically chosen.
            In next major release, this default value will be changed to None.
        :param timeout: (optional) requests timeout. How long to wait for the server to send
            data before giving up, as a float, or a `(connect timeout,
            read timeout) <timeouts>` tuple.
        :param enable_pii: (optional) Unless this is set to True,
            there will be no Personally Identifiable Information (PII) written in log.
        :param verify_ssl: (optional) requests verify. Either a boolean, in which case it 
            controls whether we verify the server's TLS certificate, or a string, in which 
            case it must be a path to a CA bundle to use. If this value is not provided, and 
            ADAL_PYTHON_SSL_NO_VERIFY env varaible is set, behavior is equivalent to 
            verify_ssl=False.
        :param proxies: (optional) requests proxies. Dictionary mapping protocol to the URL 
            of the proxy. See http://docs.python-requests.org/en/master/user/advanced/#proxies
            for details.
        '''
KjetilIN commented 6 months ago

Solved with pr #46