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.

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

Add docstrings for FileSource class and its methods #43

Open
samsammurphy opened this issue May 3, 2023 · 1 comment
Open

Add docstrings for FileSource class and its methods #43

samsammurphy opened this issue May 3, 2023 · 1 comment
Assignees

Comments

@samsammurphy
Copy link
Contributor

The FileSource class should probably have a docstring. As should it's methods, for example head().

In my case I was going through the notebook documentation. The first example in the first notebook is..

import earthkit.data
fs = earthkit.data.from_source("file", "temp_10.bufr")

The markdown comment immediately after that says "We can call head(), tail() and ls() to see metadata from the header section of the BUFR messages: "

My instinct was to run the jupyter shortcut for help...

fs.head?

but the output was

Signature: fs.head(n=5, **kwargs)
Docstring: <no docstring>
File:      ~/code/earthkit-data/earthkit/data/sources/file.py
Type:      method

i.e. no docstring describing the head() method

@sandorkertesz
Copy link
Collaborator

This is related to #40

@samsammurphy samsammurphy changed the title docstrings for FileSource class and its methods Add docstrings for FileSource class and its methods May 4, 2023
@sandorkertesz sandorkertesz self-assigned this May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants