Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add docstrings #2

Open
2 tasks done
ChristianGerloff opened this issue Apr 22, 2020 · 0 comments
Open
2 tasks done

add docstrings #2

ChristianGerloff opened this issue Apr 22, 2020 · 0 comments
Assignees
@ChristianGerloff
Labels
documentation Improvements or additions to documentation

Comments

@ChristianGerloff
Copy link
Owner

ChristianGerloff commented Apr 22, 2020 •
edited
Loading

Beschreibung

add Docstrings to splithalf module

  • module

  • functions

Example NumPy

"""Gets and prints the spreadsheet's header columns

Parameters
----------
file_loc : str
    The file location of the spreadsheet
print_cols : bool, optional
    A flag used to print the columns to the console (default is False)

Returns
-------
list
    a list of strings representing the header columns
"""

Source: https://realpython.com/documenting-python-code/
@ChristianGerloff ChristianGerloff added the documentation Improvements or additions to documentation label Apr 22, 2020
@ChristianGerloff ChristianGerloff self-assigned this Apr 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ChristianGerloff ChristianGerloff

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ChristianGerloff