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.

Sign up for GitHub

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

Jump to bottom

Config file for sphinx-documentation: Improve comments and fix typos #3543

Closed
wants to merge 27 commits into from
Closed

Config file for sphinx-documentation: Improve comments and fix typos #3543

wants to merge 27 commits into from

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

Just a few typo fixes in the config file for sphinx documentation.

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

yvonnefroehlich
yvonnefroehlich commented Oct 21, 2024
View reviewed changes
doc/conf.py Outdated Show resolved Hide resolved
@weiji14 weiji14 changed the title Config file for sphinx-documenation: Fix typos Config file for sphinx-documentation: Fix typos Oct 21, 2024
seisman and others added 2 commits October 22, 2024 07:55
@seisman @yvonnefroehlich @michaelgrund
Add instructions for installing optional dependencies (#3506)
0482394 
Co-authored-by: Yvonne Fröhlich <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
@seisman
clib.Session.virtualfile_from_vectors: Now takes a sequence of vector…
7eb93f2 
…s as its single argument (Passing multiple arguments will be unsupported in v0.16.0) (#3522)
seisman
seisman reviewed Oct 22, 2024
View reviewed changes
doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
seisman
seisman reviewed Oct 22, 2024
View reviewed changes
doc/conf.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Oct 22, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Oct 22, 2024
dependabot bot and others added 18 commits October 23, 2024 09:48
@dependabot
Build(deps): Bump actions/checkout from 4.2.0 to 4.2.1 (#3545)
8b47baa 
Bumps [actions/checkout](https://github.com/actions/checkout) from 4.2.0 to 4.2.1.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.2.0...v4.2.1)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
Build(deps): Bump actions/upload-artifact from 4.4.0 to 4.4.3 (#3546)
3333457 
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.4.0 to 4.4.3.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v4.4.0...v4.4.3)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@seisman
Fix badge links, use consistent badge style and update badge order (#…
2d481d4 
…3540)
@seisman
Fix the _validate_data_input function after refactoring data_kind (#3541
914c1c6 
)
@seisman @weiji14
clib.conversion.vectors_to_arrays: Move inline doctests into a separa…
63e8fe9 
…te test file (#3549)

Co-authored-by: Wei Ji <[email protected]>
@seisman
Explicitly check the array dtype instead of using assert_equal
72921d6
@seisman
CI: Install DCW and GSHHG datasets on Linux/macOS in the "GMT Dev Tes…
ed18111 
…ts" workflow (#3550)
@seisman @michaelgrund @yvonnefroehlich
clib.Session.create_data: Improve docstrings and fix the comments for…
68bb695 
… the `dim` parameter (#3532)

Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>
@seisman
Move Figure.psconvert into a separate file (#3553)
1e312ee
@seisman
clib.Session: Add type hints and refactor the _parse_constant and _pa…
ced2e5f 
…rse_pad methods (#3552)
@yvonnefroehlich
DOC: Fix typos "Scientific" to "scientific" (#3555)
97dc71c
@seisman
CI: Use the 'ubuntu-latest' runner in the 'Benchmarks' workflow (#3557)
c6188b9
@core-man @seisman
Figure.plot: Add the "symbol" parameter to support plotting data poin…
b2dcd88 
…ts with varying symbols (#1117)

Co-authored-by: Dongdong Tian <[email protected]>
@seisman
Figure.plot3d: Add the "symbol" parameter to support plotting data po…
ce89ccb 
…ints with varying symbols (#3559)
@seisman
Refactor _load_remote_dataset to avoid typing hints issues (#3558)
4b1c9ac
@seisman
Fix the typing hints for grd2xyz (#3560)
e67addd
@dependabot
Build(deps): Bump actions/setup-python from 5.2.0 to 5.3.0 (#3561)
abdfe1c 
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5.2.0 to 5.3.0.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5.2.0...v5.3.0)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@dependabot
Build(deps): Bump actions/checkout from 4.2.1 to 4.2.2 (#3562)
8eb2b4f 
Bumps [actions/checkout](https://github.com/actions/checkout) from 4.2.1 to 4.2.2.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.2.1...v4.2.2)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@yvonnefroehlich yvonnefroehlich self-assigned this Nov 1, 2024
@yvonnefroehlich yvonnefroehlich changed the title Config file for sphinx-documentation: Fix typos Config file for sphinx-documentation: Improve comments and fix typos Nov 1, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2024

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status Path

Image diff(s)

Added images

Modified images

Path Old New

Report last updated at commit caaa1cd

yvonnefroehlich added a commit that referenced this pull request Nov 1, 2024
@yvonnefroehlich
Add all changes from #3543
845aa96
@yvonnefroehlich yvonnefroehlich deleted the fix-typos-78-config branch November 1, 2024 19:54
@yvonnefroehlich yvonnefroehlich mentioned this pull request Nov 1, 2024
Merged
7 tasks
@yvonnefroehlich
Copy link
Member Author

New PR at

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seisman seisman seisman left review comments

Assignees

@yvonnefroehlich yvonnefroehlich

Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Milestone
0.14.0
Development

Successfully merging this pull request may close these issues.
3 participants
@yvonnefroehlich @seisman @core-man