search

eqcorrscan / EQcorrscan

Earthquake detection and analysis in Python.
https://eqcorrscan.readthedocs.io/en/latest/
Other
166 stars 86 forks source link

extract_stream methods not built in API docs. #403

Closed ikahbasi closed 4 years ago

ikahbasi commented 4 years ago

Describe the bug There aren't extract_stream methods in the tutorial of the family and detection classes. Although there are in the source of them and just don't show in the tutorial.

calum-chamberlain commented 4 years ago

Can you add links to the code and the docs pages that you expect to be showing things please - feel free to have a go at fixing this yourself on a branch based on master.

ikahbasi commented 4 years ago

family) tutorial: https://eqcorrscan.readthedocs.io/en/latest/submodules/core.match_filter.family.Family.html code: https://github.com/eqcorrscan/EQcorrscan/blob/f8665a833ff444cbe800e77c86a75ec26061d82a/eqcorrscan/core/match_filter/family.py#L752-L770

detection) tutorial: https://eqcorrscan.readthedocs.io/en/latest/submodules/core.match_filter.detection.Detection.html code: https://github.com/eqcorrscan/EQcorrscan/blob/f8665a833ff444cbe800e77c86a75ec26061d82a/eqcorrscan/core/match_filter/detection.py#L358-L405

calum-chamberlain commented 4 years ago

Sweet - you should just be able to add those methods to the relevant parts of the docs source files. In general the docs could do with a large overhaul to make them use :autogen: methods and be more easily navigable.

To be clear - these do not have anything to do with tutorials, they are the API docs.

calum-chamberlain commented 4 years ago

Closed by #411