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

doc: Move compatibility table from README to separate file #2862

Merged
merged 30 commits into from
Jan 30, 2024
Merged

doc: Move compatibility table from README to separate file #2862

merged 30 commits into from
Jan 30, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Dec 8, 2023 •
edited by seisman
Loading

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Dec 8, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.11.0 milestone Dec 8, 2023
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 8, 2023
Closed
seisman
seisman reviewed Dec 8, 2023
View reviewed changes
doc/compatibility.rst Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich changed the title Move compatiblity table to separate file Move compatiblity table from README to separate file Dec 8, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Dec 8, 2023
seisman
seisman reviewed Dec 8, 2023
View reviewed changes
README.rst Outdated Show resolved Hide resolved
@yvonnefroehlich @seisman
Link to PyGMT docs
bfff5d0 
Co-authored-by: Dongdong Tian <[email protected]>
seisman
seisman reviewed Dec 11, 2023
View reviewed changes
README.rst Show resolved Hide resolved
@weiji14 weiji14 changed the title Move compatiblity table from README to separate file Move compatibility table from README to separate file Dec 11, 2023
@seisman seisman modified the milestones: 0.11.0, 0.12.0 Dec 11, 2023
@seisman
Copy link
Member

seisman commented Dec 11, 2023

I've moved this PR to 0.12.0 milestone.

@yvonnefroehlich
Copy link
Member Author

I've moved this PR to 0.12.0 milestone.

That's fine for me.

@seisman seisman marked this pull request as draft December 11, 2023 10:14
@seisman
Copy link
Member

seisman commented Jan 14, 2024 •
edited
Loading

After thinking twice, I feel we should not wait for #2863 and go ahead with this PR. Otherwise, we'll have too much to do when addressing #2863.

@yvonnefroehlich Please let me know if you have time (and your health allows) to finish this PR.

seisman
seisman reviewed Jan 14, 2024
View reviewed changes
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/compatibility.rst Outdated Show resolved Hide resolved
@yvonnefroehlich
Copy link
Member Author

After thinking twice, I feel we should not wait for #2863 and go ahead with this PR. Otherwise, we'll have too much to do when addressing #2863.

@yvonnefroehlich Please let me know if you have time (and your health allows) to finish this PR.

If you like to finish this PR, feel free to do so. I am not sure if I can work on this in the next days.

@seisman seisman modified the milestones: 0.12.0, 0.11.0 Jan 15, 2024
@seisman seisman marked this pull request as ready for review January 15, 2024 09:12
@seisman seisman added the needs review This PR has higher priority and needs review. label Jan 15, 2024
seisman
seisman reviewed Jan 15, 2024
View reviewed changes
doc/install.md
@@ -83,12 +83,16 @@ We recommend following the instructions further on to install GMT 6.

PyGMT requires the following libraries to be installed:

- [numpy](https://numpy.org) (>= 1.23)
- [numpy](https://numpy.org)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After adopting SPEC 0 (#2863), we will also need to pin pandas and xarray. Removing the pinned version from the installation guides because most users don't care about them. For anyone who cares about the versions, we provide the link to the "compatibility table".

doc/index.rst Outdated
@@ -39,6 +40,7 @@

api/index.rst
changes.md
Minimum Supported Versions <compatibility.rst>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name "Minimum Supported GMT/Python/NumPy Versions" are too long to fit the sidebar.

README.rst
- >=6.0.0
- 3.6 - 3.8
-
Minimum Supported GMT/Python/NumPy Versions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is not shown on the index page (https://pygmt-dev--2862.org.readthedocs.build/en/2862/index.html) but is shown in the README file.

@seisman seisman requested a review from a team January 15, 2024 09:22
seisman
seisman reviewed Jan 16, 2024
View reviewed changes
doc/compatibility.rst Outdated
@@ -0,0 +1,105 @@
Minimum Supported GMT/Python/NumPy Versions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm debating if we should rename the file to minversions.md.

Copy link
Member Author

@yvonnefroehlich yvonnefroehlich Jan 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I perfer minversions.md. It's more similar to the heading (and easier to write).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in c9c1dd7.

yvonnefroehlich
yvonnefroehlich commented Jan 19, 2024
View reviewed changes
Copy link
Member Author

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to keep the table in ReStructuredText because of the length of the lines due to the links (see #2858 (comment)) or do we plan to have a separate PR for re-writing it to Markdown?

@seisman
Copy link
Member

seisman commented Jan 19, 2024

Do we want to keep the table in ReStructuredText because of the length of the lines due to the links (see #2858 (comment)) or do we plan to have a separate PR for re-writing it to Markdown?

I think we should keep the table in ReST to make this PR small for review. We may rewrite it into Markdown in a future PR, but it depends on:

  • For this table, which one of ReST and Markdown is easier to maintain?
  • After we adopt SPEC 0, we also need to pin pandas and xarray (see Migrate from NEP 029 to SPEC 0 #2863). The table will be more complicated than now.

So, better to decide if we want to rewrite in Markdown after addressing PR #2863.

@seisman seisman requested a review from a team January 23, 2024 08:17
@seisman seisman merged commit a60e136 into main Jan 30, 2024
8 of 9 checks passed
@seisman seisman deleted the move-comptab-to-file branch January 30, 2024 16:12
@seisman seisman removed the needs review This PR has higher priority and needs review. label Jan 30, 2024
@yvonnefroehlich yvonnefroehlich mentioned this pull request Jan 30, 2024
Merged
7 tasks
@yvonnefroehlich yvonnefroehlich changed the title Move compatibility table from README to separate file doc: Move compatibility table from README to separate file Jan 31, 2024
@yvonnefroehlich yvonnefroehlich mentioned this pull request Jan 31, 2024
Merged
9 tasks
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
Projects
None yet
Milestone
0.11.0
Development

Successfully merging this pull request may close these issues.

Move the long "Compatibility" table to a separate file
2 participants
@yvonnefroehlich @seisman