Changeset 1831:2cde398ff6cd


Ignore:
Timestamp:
Jul 8, 2019, 11:25:53 PM (3 months ago)
Author:
Stefan Schwarzer <sschwarzer@…>
Branch:
default
histedit_source:
4de4002bf902fc7d16f4604a875265b84de147aa
Message:
Be more explicit in docstrings

Don't tell the reader not only what doesn't happen, but also what
_does_ happen. :-)
File:
1 edited

Legend:

Unmodified
Added
Removed
  • ftputil/path.py

    r1830 r1831  
    1 # Copyright (C) 2003-2018, Stefan Schwarzer <sschwarzer@sschwarzer.net>
     1# Copyright (C) 2003-2019, Stefan Schwarzer <sschwarzer@sschwarzer.net>
    22# and ftputil contributors (see `doc/contributors.txt`)
    33# See the file LICENSE for licensing terms.
     
    158158        directory (no link).
    159159
    160         A non-existing path does _not_ cause a `PermanentError`.
     160        A non-existing path does _not_ cause a `PermanentError`,
     161        instead return `False`.
    161162        """
    162163        return self._is_file_system_entity(path, "dir")
     
    167168        file (no link).
    168169
    169         A non-existing path does _not_ cause a `PermanentError`.
     170        A non-existing path does _not_ cause a `PermanentError`,
     171        instead return `False`.
    170172        """
    171173        return self._is_file_system_entity(path, "file")
     
    175177        Return true if the `path` exists and is a link.
    176178
    177         A non-existing path does _not_ cause a `PermanentError`.
     179        A non-existing path does _not_ cause a `PermanentError`,
     180        instead return `False`.
    178181        """
    179182        path = ftputil.tool.as_unicode(path)
Note: See TracChangeset for help on using the changeset viewer.