Skip to content

Update install.rst#324

Merged
seisman merged 4 commits intoGenericMappingTools:masterfrom
btozer:patch-1
Oct 9, 2019
Merged

Update install.rst#324
seisman merged 4 commits intoGenericMappingTools:masterfrom
btozer:patch-1

Conversation

@btozer
Copy link
Contributor

@btozer btozer commented Aug 29, 2019

Description of proposed changes

Include explicit instruction for how to set GMT_LIBRARY_PATH

Fixes #

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.

@welcome
Copy link

welcome bot commented Aug 29, 2019

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
  • No matter what, we are really grateful that you put in the effort to do this! 🎉

weiji14
weiji14 reviewed Sep 2, 2019
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Hi @btozer! Thanks for submitting this quick documentation fix. Sorry for all the red warnings about tests failing, it really shouldn't have been doing that. I've restarted the Linux Travis-CI build which passed, but we'll need to wait for one of the other core devs to restart the Mac Azure one.

If you have more time, you could make the example a bit clearer. For example, I found this line in an old pull request at #279 which used

export GMT_LIBRARY_PATH=$HOME/anaconda3/envs/pygmt/lib

Also just a side note that it would be great to give Windows users proper instructions as well, i.e. set the path to the gmt_w64.dll file, c.f. #285.

weiji14
weiji14 requested changes Oct 1, 2019
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Hi again @btozer, I've suggested a few changes that should make it easier for Windows 🏁 users. Feel free to make any other changes as you see fit, but once you're done, click on the 'Update branch' button to bring your patch up to date with the master branch, and this should be ready to merge!

@weiji14 weiji14 added this to the 0.1.0 milestone Oct 4, 2019
btozer and others added 3 commits October 9, 2019 12:53
@btozer @weiji14
Update doc/install.rst
77ed38b 
Co-Authored-By: Wei Ji <23487320+weiji14@users.noreply.github.com>
@btozer @weiji14
Update doc/install.rst
126d747 
Co-Authored-By: Wei Ji <23487320+weiji14@users.noreply.github.com>
@btozer
Merge branch 'master' into patch-1
a3e9043
@btozer btozer requested a review from weiji14 October 9, 2019 19:57
weiji14
weiji14 approved these changes Oct 9, 2019
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Yep, looks good!

@weiji14
Copy link
Member

weiji14 commented Oct 9, 2019

@seisman could you merge this in? It's saying I'm not authorized to merge into the master branch.

@seisman seisman merged commit c2efb20 into GenericMappingTools:master Oct 9, 2019
@welcome
Copy link

welcome bot commented Oct 9, 2019

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

@seisman
Copy link
Member

seisman commented Oct 9, 2019

@btozer Thanks for your contributions!

@weiji14 Not sure why you can't merge it, since you're now already the team member. Possibly because the PR was opened before you joined the team?

@weiji14
Copy link
Member

weiji14 commented Oct 9, 2019

@weiji14 Not sure why you can't merge it, since you're now already the team member. Possibly because the PR was opened before you joined the team?

Ah that's interesting, but I guess it kinda makes sense. Anyways, good work @btozer!

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

Reviewers

@weiji14 weiji14 weiji14 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.1.x

Development

Successfully merging this pull request may close these issues.

3 participants

@btozer @weiji14 @seisman