search

swiss-seismological-service / scrtdd

Double Difference Relocator for SeisComP
27 stars 10 forks source link

Documentation review and formatting #41

Closed damb closed 3 years ago

damb commented 3 years ago

This PR includes a documentation review of both module configuration parameters and the application's README file. It mainly fixes typos and grammar issues. Similar issues are fixed in source code comments, too.

Besides, some formatting issues are corrected.

Solves #40.

luca-s commented 3 years ago

Thanks a lot, I will review this soon

damb commented 3 years ago

Thanks a lot, I will review this soon

@luca-s, it is still marked as WIP. I'll let you know if it is ready for review.

damb commented 3 years ago

@luca-s, ready to be reviewed.

Note, that I didn't fix the indentation of apps/scrtdd/descriptions/scrtdd.xml. IMO, it would be good to do so.

damb commented 3 years ago

Ok. I resolved the merge conflict.

luca-s commented 3 years ago

Wow, thanks a lot. I will review this soon.

Note, that I didn't fix the indentation of apps/scrtdd/descriptions/scrtdd.xml. IMO, it would be good to do so.

This is a good idea.

luca-s commented 3 years ago

Merged! Thanks a lot

damb commented 3 years ago

Thanks for merging.

Though, the outputs of scrtdd --help within the README might have been diverged. Did you verify that?

luca-s commented 3 years ago

Good point! I will have to update that too