-
Notifications
You must be signed in to change notification settings - Fork 234
Add an issue template for wrapping GMT modules #4152
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.
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
ba41504
Add an issue template for wrapping GMT modules
seisman 62f9398
Merge branch 'main' into template/wrapper
seisman 7bd77ff
Update module template
seisman d8436ec
Update template
seisman c883ffc
Fix style
seisman 8f0d71b
Merge branch 'main' into template/wrapper
seisman e62bca8
Format the template
seisman f35a0eb
Update .github/ISSUE_TEMPLATE/3-module_request.md
seisman 4365efd
Reforamt
seisman f00393a
Add common option flags -U/-X/-Y
seisman a2ec865
Update .github/ISSUE_TEMPLATE/3-module_request.md [skip ci]
seisman 98cc3b6
Update .github/ISSUE_TEMPLATE/3-module_request.md
seisman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| name: Wrapper for a GMT module | ||
| about: Track the progress of wrapping a GMT module. [For project maintainers only!] | ||
| title: "Wrapper: Description of the module" | ||
| labels: ["feature request"] | ||
|
|
||
| --- | ||
|
|
||
| *This issue serves as the central place for discussing and tracking the implementation of the `<wrapper>` method in PyGMT.* | ||
| *The issue will be closed when the initial implementation is complete. Progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.* | ||
|
|
||
| ## Documentation | ||
|
|
||
| - GMT: https://docs.generic-mapping-tools.org/dev/<module>.html | ||
| - GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/<module> | ||
| - PyGMT: https://www.pygmt.org/dev/api/generated/<wrapper>.html | ||
|
|
||
| ## GMT Option Flags | ||
|
|
||
| ☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won’t implement*. | ||
seisman marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - [ ] `-R`: `region` #XXX @XXX | ||
| - [ ] `-J`: `projection` #XXX @XXX | ||
| - [ ] ... | ||
|
|
||
| ## Notes on Input Formats | ||
|
|
||
| *Add any notes on the input formats, especially the meaning of columns.* | ||
|
|
||
| ## Linked Pull Requests | ||
|
|
||
| - [ ] Initial feature implementation #XXX @XXX | ||
| - [ ] Add a tutorial or gallery example | ||
|
|
||
| ## Related Issues and Discussions | ||
|
|
||
| *Add links to related wrapper discussions, API design threads, or upstream GMT changes here.* | ||
This file was deleted.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.