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 documentation for preprocessing to README #3

Open
imagejan opened this issue Jan 18, 2023 · 2 comments
Open

Add documentation for preprocessing to README #3

imagejan opened this issue Jan 18, 2023 · 2 comments

Comments

@imagejan
Copy link
Member

It would be good to point to yokogawa.py in the README as well.
@tibuch
Copy link
Contributor

tibuch commented Jan 18, 2023

For having it consistent it should appear there, I agree. But I am wondering if we increase the maintenance burden on us by having to update the README for every added function. Maybe we should remove it completely?

@imagejan
Copy link
Member Author

I don't have strong feelings about this. You're right, we still have the docstrings that should contain all the necessary information. On the other hand, having a summary of the repo contents in the README might be useful as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@imagejan @tibuch