Skip to content

Combine documentation and compatibility sections in README.rst - #1415

Merged
weiji14 merged 6 commits into
mainfrom
docs-versions
Aug 7, 2021
Merged

Combine documentation and compatibility sections in README.rst#1415
weiji14 merged 6 commits into
mainfrom
docs-versions

Conversation

@maxrjones

@maxrjonesmaxrjones commented Aug 5, 2021

Copy link
Copy Markdown
Member

Description of proposed changes

This PR condenses the README.md file a bit based on suggestions in #1358.

I will submit another commit to this branch with a version of the table with links to both the release notes and documentation for comparison.

Fixes#1358

Reminders

  • 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 adding new functionality, add an example to docstrings or tutorials.

Slash Commands

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

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman

seisman commented Aug 5, 2021

Copy link
Copy Markdown
Member

@meghanrjones There is a conflict with the latest README.rst file.

@maxrjones

maxrjones commented Aug 5, 2021

Copy link
Copy Markdown
MemberAuthor

@meghanrjones There is a conflict with the latest README.rst file.

Thanks, resolved now.

The only materials that are no longer available are links to the latest documentation and unstable documentation. Perhaps I could just add those links as a footnote below the table?

weiji14
weiji14 reviewed Aug 5, 2021
View reviewed changes

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @meghanrjones, could you also run rst2html and see if it renders ok? Just want to make sure the README shows up correctly on https://pypi.org/project/pygmt/ later.

Comment threadREADME.rst Outdated
Meghan Jonesand others added 2 commits August 5, 2021 17:50
Meghan Jones@weiji14
Combine columns
b021347
Co-authored-by: Wei Ji <weiji14@users.noreply.github.com>
Meghan Jones
Add link to dev docs
559e418
@maxrjones

maxrjones commented Aug 5, 2021

Copy link
Copy Markdown
MemberAuthor

Thanks @meghanrjones, could you also run rst2html and see if it renders ok? Just want to make sure the README shows up correctly on https://pypi.org/project/pygmt/ later.

Looks OK

@maxrjonesmaxrjones added the documentation Improvements or additions to documentation label Aug 6, 2021
core-man
core-man reviewed Aug 6, 2021
View reviewed changes
Comment threadREADME.rst
core-man
core-man reviewed Aug 6, 2021
View reviewed changes
Comment threadREADME.rst Outdated
@weiji14weiji14 changed the title Combine documentation and compatibility sections in README.mdCombine documentation and compatibility sections in README.rstAug 6, 2021
Meghan Jones@core-man
Apply suggestions from code review
45b5e2e
Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com>
core-man
core-man approved these changes Aug 6, 2021
View reviewed changes

@core-mancore-man left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great~

@maxrjonesmaxrjones added the final review call This PR requires final review and approval from a second reviewer label Aug 6, 2021
michaelgrund
michaelgrund reviewed Aug 6, 2021
View reviewed changes
Comment threadREADME.rst
@seismanseisman added this to the 0.4.1 milestone Aug 7, 2021
weiji14
weiji14 approved these changes Aug 7, 2021
View reviewed changes

@weiji14weiji14 left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok, I'll merge this in directly :) Thanks Meghan!

FYI, the new compatibility table looks ok on TestPyPI at https://test.pypi.org/project/pygmt/0.4.1.dev30.

image

@weiji14
weiji14 merged commit b5841d6 into mainAug 7, 2021
@weiji14
weiji14 deleted the docs-versions branch August 7, 2021 09:05
@weiji14weiji14 removed the final review call This PR requires final review and approval from a second reviewer label Aug 7, 2021
@weiji14weiji14 mentioned this pull request Aug 10, 2021
Merged
5 tasks
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Meghan Jones@weiji14
@core-manJosh Sixsmith
Combine documentation and compatibility sections in README.rst (Gener…
a20b749
…icMappingTools#1415)
Condense the main README file a bit by merging the
PyGMT compatibility table with the list of links to old
versions of the documentation.
Co-authored-by: Wei Ji <weiji14@users.noreply.github.com>
Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seismanseismanseisman approved these changes
@michaelgrundmichaelgrundmichaelgrund approved these changes
@weiji14weiji14weiji14 approved these changes
@willschlitzerwillschlitzerwillschlitzer approved these changes
@core-mancore-mancore-man approved these changes

Assignees

No one assigned

Labels

documentationImprovements or additions to documentation

Projects

None yet

Milestone

0.4.1

Development

Successfully merging this pull request may close these issues.

Remove the "documentation for other versions" section from the README file

6 participants

@maxrjones@seisman@michaelgrund@weiji14@willschlitzer@core-man