Add proper documentation to QuakeML module. #257

Open
M.R.D. wants to merge 2 commits from quakeml into master
M.R.D. commented 2 months ago
Collaborator

Description

Motivation and Context

How has this been tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have added unit tests and all tests pass.
  • I have updated the documentation accordingly.
  • I have updated the changelog accordingly.
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here. --> ## How has this been tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, tests ran to see how --> <!--- your change affects other areas of the code, etc. --> ## Screenshots (if appropriate): ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have added unit tests and all tests pass. - [ ] I have updated the documentation accordingly. - [ ] I have updated the changelog accordingly.
M.R.D. added 1 commit 2 months ago
dfd7f497a4 WIP: adding descriptions for quakeml.py
M.R.D. added 2 commits 2 months ago
M.R.D. added 1 commit 2 months ago
5ee3d3d996 correcting small mistakes in class descriptions
emolch force-pushed quakeml from 5ee3d3d996 to dcb39dc664 2 months ago
emolch force-pushed quakeml from dcb39dc664 to 849ef7a86b 2 months ago
emolch changed title from WIP: adding descriptions for quakeml.py to Add proper documentation to QuakeML module. 2 months ago
emolch added the
Ready
label 2 months ago
All checks were successful
continuous-integration/drone/push Build is passing
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
Sign in to join this conversation.
No reviewers
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

Loading…
There is no content yet.