Skip to content

Commit

Permalink
moved docstrings to Google format
Browse files Browse the repository at this point in the history
  • Loading branch information
srobuttiteraki authored and FlorianWilhelm committed Oct 28, 2018
1 parent 3b5c689 commit b3a68e5
Showing 1 changed file with 35 additions and 15 deletions.
50 changes: 35 additions & 15 deletions src/pyscaffoldext/custom_extension/custom_extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,13 @@ def add_entry_point(self, struct, opts):
def add_install_requires(struct, opts):
"""
Add PyScaffold dependency to install_requires
:param struct:
:param opts:
:return:
Args:
struct:
opts:
Returns:
"""
setupcfg = ConfigUpdater()
setupcfg.read_string(struct[opts["project"]]["setup.cfg"])
Expand All @@ -120,9 +124,13 @@ def set_pyscaffoldext_namespace(struct, opts):
the project to create. If the namespace parameter is
already specified, pyscaffoldext is prepended to the specified
namespace.
:param struct:
:param opts:
:return:
Args:
struct:
opts:
Returns:
"""
namespace_parameter = opts.get("namespace", None)
namespace_list = [PYSCAFFOLDEXT_NS]
Expand Down Expand Up @@ -158,9 +166,13 @@ def add_custom_extension_structure(struct, opts):
"""
Adds an empty class that will serve as the skeleton
for the logic of the extension to create
:param struct:
:param opts:
:return:
Args:
struct:
opts:
Returns:
"""
custom_extension_file_content = extension(
get_class_name_from_opts(opts))
Expand All @@ -177,9 +189,13 @@ def add_custom_extension_structure(struct, opts):
def add_readme(struct, opts):
"""
Add README template
:param struct:
:param opts:
:return:
Args:
struct:
opts:
Returns:
"""
file_content = readme(
get_class_name_from_opts(opts))
Expand All @@ -199,9 +215,13 @@ def check_project_name(struct, opts):
The project name must start with 'pyscaffoldext-' and
the package name shouldn't contain the redundant
'pyscaffoldext_' in the beginning of the name.
:param struct:
:param opts:
:return:
Args:
struct:
opts:
Returns:
"""
if not opts['project'].startswith('pyscaffoldext-') and not opts['force']:
raise InvalidProjectNameException
Expand Down

0 comments on commit b3a68e5

Please sign in to comment.