Fix RtD index page links and update documentation links and naming. #286
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated documentation links and clarified naming conventions in index.md and README.md. Changed the reference to the license from the generic term [license] to [Apache 2.0 license]. Additionally, the [command-line reference] has been renamed to [Command-line Usage], and [API Reference] was added for clarity. These changes improve the user's understanding of the content and ensure that the information is accurately linked.
Removed Sri Kainkaryam from the credits section of the README file. Sri is no longer maintaining the project; Altay Sansal is the current maintainer.
Codecov Report
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. @@ Coverage Diff @@
## main #286 +/- ##
=======================================
Coverage 84.32% 84.32%
=======================================
Files 46 46
Lines 2194 2194
Branches 349 349
=======================================
Hits 1850 1850
Misses 301 301
Partials 43 43 |
The commit removes `grid_density_qc` and `parse_index_types` from the documentation of the `segy` module in the `mdio.converters`. This exclusion is necessary to streamline the documentation and keep only relevant publicly used functions. This helps to reduce clutter and avoid confusion for the end users.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated documentation links and clarified naming conventions in index.md and README.md. Changed the reference to the license from the generic term [license] to [Apache 2.0 license]. Additionally, the [command-line reference] has been renamed to [Command-line Usage], and [API Reference] was added for clarity. These changes improve the user's understanding of the content and ensure that the information is accurately linked.