Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Add documentation for preprocessing to README #3

Closed
imagejan opened this issue Jan 18, 2023 · 3 comments
Closed

Add documentation for preprocessing to README #3

imagejan opened this issue Jan 18, 2023 · 3 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.

@tibuch
Copy link
Contributor

tibuch commented Oct 28, 2024

Moved to fmi-faim/faim-ipa#189.

@tibuch tibuch closed this as completed Oct 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants