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

Some minor remarks on the documentation #13

Closed
fwalter opened this issue Dec 30, 2020 · 3 comments
Closed

Some minor remarks on the documentation #13

fwalter opened this issue Dec 30, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@fwalter
Copy link

fwalter commented Dec 30, 2020

Hi again,

MINOR TYPOS IN DOCUMENTATION AND CODE MESSAGES:

"You canthen enter the rsudp conda environment by typing "conda activate rsudp" and then run rsudp by using the command "rs-client -h""

"The client then instantiates the relevant threading.Thread objects as and passes"

In the configuration file and documentation, the sound setting is sometimes referred to as "alarm sound" and sometimes as "alert sound". I assume these are the same?

REMARKS ON DOCUMENTATION

  1. Troubleshooting rsudp: "Once you have a good setup worked out, you will typically be able to start and run this program without errors.": This is a somewhat trivial statement and may annoy users who are not getting their Raspberry devices running. I suggest being more specific here or removing this sentence.

1.2.1. Message types: why not document "data"? As a non-python expert (though frequent user) I spent some time googling what the data types starting with a "b" mean and how they have to be handled. Then I had to find the correct methods in the rsudp modules. It would be easier to provide a function that does all this for users only interested in the data stream (via an obspy stream object, e.g., see my other issue https://github.com/raspishake/rsudp/issues/12 ).

https://github.com/openjournals/joss-reviews/issues/2565

@fwalter
Copy link
Author

fwalter commented Dec 30, 2020

One more comment: When changing the python modules I noticed that the changed code is not executed unless the start-up script is re-run. Again, I am not a python expert, so this may be obvious, but it would have helped me to see this in the documentation.

@iannesbitt
Copy link
Collaborator

These are very helpful fixes, thank you. I will work on incorporating them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants