File tree Expand file tree Collapse file tree 3 files changed +15
-9
lines changed Expand file tree Collapse file tree 3 files changed +15
-9
lines changed Original file line number Diff line number Diff line change @@ -141,7 +141,7 @@ jobs:
141
141
142
142
# Upload coverage to Codecov
143
143
- name : Upload coverage to Codecov
144
- uses : codecov/codecov-action@v1.4.1
144
+ uses : codecov/codecov-action@v1.5.0
145
145
with :
146
146
file : ./coverage.xml # optional
147
147
env_vars : OS,PYTHON,NUMPY
Original file line number Diff line number Diff line change @@ -219,7 +219,7 @@ General guidelines for pull requests (PRs):
219
219
do.
220
220
* Each pull request should consist of a ** small** and logical collection of changes.
221
221
* Larger changes should be broken down into smaller components and integrated
222
- separately.
222
+ separately. For example, break the wrapping of aliases into multiple pull requests.
223
223
* Bug fixes should be submitted in separate PRs.
224
224
* Use underscores for all Python (* .py) files as per [ PEP8] ( https://www.python.org/dev/peps/pep-0008/ ) ,
225
225
not hyphens. Directory names should also use underscores instead of hyphens.
@@ -303,6 +303,12 @@ warn us and you can make a new commit with the formatted code.
303
303
Even better, you can just write ` /format ` in the first line of any comment in a
304
304
Pull Request to lint the code automatically.
305
305
306
+ When wrapping a new alias, use an underscore to separate words bridged by vowels
307
+ (aeiou), such as ` no_skip ` and ` z_only ` . Do not use an underscore to separate
308
+ words bridged only by consonants, such as ` distcalc ` , and ` crossprofile ` . This
309
+ convention is not applied by the code checking tools, but the PyGMT maintainers
310
+ will comment on any pull requests as needed.
311
+
306
312
We also use [ flake8] ( http://flake8.pycqa.org/en/latest/ ) and
307
313
[ pylint] ( https://www.pylint.org/ ) to check the quality of the code and quickly catch
308
314
common errors.
Original file line number Diff line number Diff line change @@ -98,8 +98,8 @@ def data_format_code(convention, component="full"):
98
98
@use_alias (
99
99
R = "region" ,
100
100
J = "projection" ,
101
+ A = "offset" ,
101
102
B = "frame" ,
102
- C = "offset" ,
103
103
N = "no_clip" ,
104
104
V = "verbose" ,
105
105
X = "xshift" ,
@@ -334,8 +334,8 @@ def update_pointers(data_pointers):
334
334
if arg is None :
335
335
spec .append (0 )
336
336
else :
337
- if "C " not in kwargs :
338
- kwargs ["C " ] = True
337
+ if "A " not in kwargs :
338
+ kwargs ["A " ] = True
339
339
spec .append (arg )
340
340
341
341
# or assemble the 2D array for the case of lists as values
@@ -389,8 +389,8 @@ def update_pointers(data_pointers):
389
389
if arg is None :
390
390
row .append (0 )
391
391
else :
392
- if "C " not in kwargs :
393
- kwargs ["C " ] = True
392
+ if "A " not in kwargs :
393
+ kwargs ["A " ] = True
394
394
row .append (arg [index ])
395
395
spec_array .append (row )
396
396
spec = spec_array
@@ -435,8 +435,8 @@ def update_pointers(data_pointers):
435
435
if arg is None :
436
436
row .append (0 )
437
437
else :
438
- if "C " not in kwargs :
439
- kwargs ["C " ] = True
438
+ if "A " not in kwargs :
439
+ kwargs ["A " ] = True
440
440
row .append (arg [index ])
441
441
spec_array .append (row )
442
442
spec = spec_array
You can’t perform that action at this time.
0 commit comments