Avatar for the GenericMappingTools user
GenericMappingTools
pygmt
BlogDocsChangelog

Figure.shift_origin: Improve docstrings, add inline examples and add type hints

#2879Merged
Comparing
docs/shift_origin
(
1148c88
) with
main
(
e0593d2
)
CodSpeed Performance Gauge
0%
Improvements
0
Regressions
0
Untouched
64
New
0
Dropped
0
Ignored
0

Benchmarks

Passed

test_grdlandmask_no_outgrid
pygmt/tests/test_grdlandmask.py::test_grdlandmask_no_outgrid
CodSpeed Performance Gauge
+4%
153 ms
147.5 ms
test_sph2grd_no_outgrid
pygmt/tests/test_sph2grd.py::test_sph2grd_no_outgrid
CodSpeed Performance Gauge
+2%
415.7 ms
406.2 ms
test_sphinterpolate_no_outgrid
pygmt/tests/test_sphinterpolate.py::test_sphinterpolate_no_outgrid
CodSpeed Performance Gauge
0%
74.1 ms
73.8 ms
test_io_load_dataarray
pygmt/tests/test_io.py::test_io_load_dataarray
CodSpeed Performance Gauge
0%
26 ms
25.9 ms
test_text_multiple_lines_of_text
pygmt/tests/test_text.py::test_text_multiple_lines_of_text
CodSpeed Performance Gauge
0%
19.6 ms
19.5 ms
test_makecpt_output_cpt_file
pygmt/tests/test_makecpt.py::test_makecpt_output_cpt_file
CodSpeed Performance Gauge
0%
11.8 ms
11.8 ms
test_grdcontour_labels
pygmt/tests/test_grdcontour.py::test_grdcontour_labels
CodSpeed Performance Gauge
0%
19.3 ms
19.2 ms
test_basemap
pygmt/tests/test_basemap.py::test_basemap
CodSpeed Performance Gauge
0%
15.7 ms
15.7 ms
test_surface_input_xyz
pygmt/tests/test_surface.py::test_surface_input_xyz
CodSpeed Performance Gauge
0%
25.4 ms
25.3 ms
test_grdgradient_no_outgrid
pygmt/tests/test_grdgradient.py::test_grdgradient_no_outgrid
CodSpeed Performance Gauge
0%
17.7 ms
17.7 ms
test_grdcut_dataarray_in_dataarray_out
pygmt/tests/test_grdcut.py::test_grdcut_dataarray_in_dataarray_out
CodSpeed Performance Gauge
0%
17.6 ms
17.6 ms
test_timestamp_font
pygmt/tests/test_timestamp.py::test_timestamp_font
CodSpeed Performance Gauge
0%
15.7 ms
15.7 ms
test_plot_vectors
pygmt/tests/test_plot.py::test_plot_vectors
CodSpeed Performance Gauge
0%
16.7 ms
16.7 ms
test_project_input_matrix[DataFrame]
pygmt/tests/test_project.py::test_project_input_matrix[DataFrame]
CodSpeed Performance Gauge
0%
9.5 ms
9.5 ms
test_legend_entries
pygmt/tests/test_legend.py::test_legend_entries
CodSpeed Performance Gauge
0%
127.9 ms
127.8 ms
test_grdtrack_input_dataframe_and_dataarray
pygmt/tests/test_grdtrack.py::test_grdtrack_input_dataframe_and_dataarray
CodSpeed Performance Gauge
0%
9.9 ms
9.9 ms
test_plot3d_vectors
pygmt/tests/test_plot3d.py::test_plot3d_vectors
CodSpeed Performance Gauge
0%
17.1 ms
17.1 ms
test_velo_pandas_dataframe
pygmt/tests/test_velo.py::test_velo_pandas_dataframe
CodSpeed Performance Gauge
0%
21.9 ms
21.9 ms
test_rose_plot_data_using_cpt
pygmt/tests/test_rose.py::test_rose_plot_data_using_cpt
CodSpeed Performance Gauge
0%
18.2 ms
18.2 ms
test_psconvert
pygmt/tests/test_psconvert.py::test_psconvert
CodSpeed Performance Gauge
0%
25.8 ms
25.8 ms
test_grdclip_no_outgrid
pygmt/tests/test_grdclip.py::test_grdclip_no_outgrid
CodSpeed Performance Gauge
0%
17.7 ms
17.7 ms
test_project_input_matrix[array]
pygmt/tests/test_project.py::test_project_input_matrix[array]
CodSpeed Performance Gauge
0%
9.2 ms
9.2 ms
test_select_input_dataframe
pygmt/tests/test_select.py::test_select_input_dataframe
CodSpeed Performance Gauge
0%
34.7 ms
34.7 ms
test_solar_set_terminator_datetime[terminator_datetime1]
pygmt/tests/test_solar.py::test_solar_set_terminator_datetime[terminator_datetime1]
CodSpeed Performance Gauge
0%
25.2 ms
25.1 ms
test_meca_spec_multiple_focalmecha[dict_mecha]
pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[dict_mecha]
CodSpeed Performance Gauge
0%
32.3 ms
32.2 ms
test_subplot_basic_frame
pygmt/tests/test_subplot.py::test_subplot_basic_frame
CodSpeed Performance Gauge
0%
62.9 ms
62.9 ms
test_compute_bins_no_outfile
pygmt/tests/test_grdhisteq.py::test_compute_bins_no_outfile
CodSpeed Performance Gauge
0%
10.5 ms
10.5 ms
test_inset_aliases
pygmt/tests/test_inset.py::test_inset_aliases
CodSpeed Performance Gauge
0%
567.8 ms
567.6 ms
test_regular_grid_no_outgrid
pygmt/tests/test_triangulate.py::test_regular_grid_no_outgrid
CodSpeed Performance Gauge
0%
77.1 ms
77.1 ms
test_meca_spec_multiple_focalmecha[array2d]
pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[array2d]
CodSpeed Performance Gauge
0%
31.1 ms
31 ms
test_geopandas_info_geodataframe
pygmt/tests/test_geopandas.py::test_geopandas_info_geodataframe
CodSpeed Performance Gauge
0%
24.9 ms
24.8 ms
test_grdfill_dataarray_out
pygmt/tests/test_grdfill.py::test_grdfill_dataarray_out
CodSpeed Performance Gauge
0%
17.6 ms
17.6 ms
test_grd2cpt
pygmt/tests/test_grd2cpt.py::test_grd2cpt
CodSpeed Performance Gauge
0%
41.5 ms
41.5 ms
test_begin_end
pygmt/tests/test_session_management.py::test_begin_end
CodSpeed Performance Gauge
0%
35.3 ms
35.3 ms
test_nearneighbor_input_xyz
pygmt/tests/test_nearneighbor.py::test_nearneighbor_input_xyz
CodSpeed Performance Gauge
0%
1.4 s
1.4 s
test_grdview_drapegrid_dataarray
pygmt/tests/test_grdview.py::test_grdview_drapegrid_dataarray
CodSpeed Performance Gauge
0%
1.3 s
1.3 s
test_sphdistance_no_outgrid
pygmt/tests/test_sphdistance.py::test_sphdistance_no_outgrid
CodSpeed Performance Gauge
0%
148.9 ms
148.9 ms
test_wiggle_data_incols
pygmt/tests/test_wiggle.py::test_wiggle_data_incols
CodSpeed Performance Gauge
0%
16.3 ms
16.3 ms
test_meca_spec_multiple_focalmecha[dict_mecha_mixed]
pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[dict_mecha_mixed]
CodSpeed Performance Gauge
0%
32.3 ms
32.3 ms
test_grdfilter_dataarray_in_dataarray_out
pygmt/tests/test_grdfilter.py::test_grdfilter_dataarray_in_dataarray_out
CodSpeed Performance Gauge
0%
17.8 ms
17.8 ms
test_project_input_matrix[Dataset]
pygmt/tests/test_project.py::test_project_input_matrix[Dataset]
CodSpeed Performance Gauge
0%
11.3 ms
11.3 ms
test_delaunay_triples_input_xyz
pygmt/tests/test_triangulate.py::test_delaunay_triples_input_xyz
CodSpeed Performance Gauge
0%
44.8 ms
44.8 ms
test_which_multiple
pygmt/tests/test_which.py::test_which_multiple
CodSpeed Performance Gauge
0%
13.8 ms
13.8 ms
test_grdimage_grid_and_shading_with_xarray[png]
pygmt/tests/test_grdimage.py::test_grdimage_grid_and_shading_with_xarray[png]
CodSpeed Performance Gauge
0%
1.3 s
1.3 s
test_solar_set_terminator_datetime[terminator_datetime_string]
pygmt/tests/test_solar.py::test_solar_set_terminator_datetime[terminator_datetime_string]
CodSpeed Performance Gauge
0%
25.9 ms
25.9 ms
test_meca_spec_multiple_focalmecha[dataframe]
pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[dataframe]
CodSpeed Performance Gauge
0%
31.7 ms
31.8 ms
test_grdinfo
pygmt/tests/test_grdinfo.py::test_grdinfo
CodSpeed Performance Gauge
0%
8 ms
8 ms
test_x2sys_init_units_gap
pygmt/tests/test_x2sys_init.py::test_x2sys_init_units_gap
CodSpeed Performance Gauge
0%
11.4 ms
11.4 ms
test_x2sys_cross_input_dataframe_output_dataframe
pygmt/tests/test_x2sys_cross.py::test_x2sys_cross_input_dataframe_output_dataframe
CodSpeed Performance Gauge
0%
25 ms
25 ms
test_equalize_grid_no_outgrid
pygmt/tests/test_grdhisteq.py::test_equalize_grid_no_outgrid
CodSpeed Performance Gauge
0%
17.7 ms
17.7 ms
test_histogram[list]
pygmt/tests/test_histogram.py::test_histogram[list]
CodSpeed Performance Gauge
0%
16 ms
16 ms
test_grdvolume_no_outgrid
pygmt/tests/test_grdvolume.py::test_grdvolume_no_outgrid
CodSpeed Performance Gauge
0%
9.5 ms
9.5 ms
test_xyz2grd_input_array[array]
pygmt/tests/test_xyz2grd.py::test_xyz2grd_input_array[array]
CodSpeed Performance Gauge
0%
48.9 ms
49 ms
test_ternary_3_labels
pygmt/tests/test_ternary.py::test_ternary_3_labels
CodSpeed Performance Gauge
0%
27.1 ms
27.2 ms
test_grd2xyz
pygmt/tests/test_grd2xyz.py::test_grd2xyz
CodSpeed Performance Gauge
0%
9.7 ms
9.7 ms
test_xyz2grd_input_array[Dataset]
pygmt/tests/test_xyz2grd.py::test_xyz2grd_input_array[Dataset]
CodSpeed Performance Gauge
0%
46.4 ms
46.6 ms
test_info_pandas_dataframe_date_column[datetime64[ns]]
pygmt/tests/test_info.py::test_info_pandas_dataframe_date_column[datetime64[ns]]
CodSpeed Performance Gauge
0%
12.7 ms
12.7 ms
test_histogram[Series]
pygmt/tests/test_histogram.py::test_histogram[Series]
CodSpeed Performance Gauge
0%
16 ms
16.1 ms
test_info_xarray_dataset_time_column
pygmt/tests/test_info.py::test_info_xarray_dataset_time_column
CodSpeed Performance Gauge
0%
12.8 ms
12.9 ms
test_grdproject_no_outgrid[+proj=merc +ellps=WGS84 +units=m +width=10]
pygmt/tests/test_grdproject.py::test_grdproject_no_outgrid[+proj=merc +ellps=WGS84 +units=m +width=10]
CodSpeed Performance Gauge
-1%
21.1 ms
21.4 ms
test_grdproject_no_outgrid[M10c]
pygmt/tests/test_grdproject.py::test_grdproject_no_outgrid[M10c]
CodSpeed Performance Gauge
-1%
20.7 ms
21 ms
test_grdproject_no_outgrid[EPSG:3395 +width=10]
pygmt/tests/test_grdproject.py::test_grdproject_no_outgrid[EPSG:3395 +width=10]
CodSpeed Performance Gauge
-2%
21.2 ms
21.5 ms
test_grdsample_dataarray_out
pygmt/tests/test_grdsample.py::test_grdsample_dataarray_out
CodSpeed Performance Gauge
-2%
19.1 ms
19.4 ms

Commits

Click on a commit to change the comparison range
Base
main
e0593d2
0%
Merge branch 'main' into docs/shift_origin
0f8744c
1 year ago
by seisman
+21%
Rewrap to 88 characters
c325925
1 year ago
by seisman
-21%
Explicitly set shift unit
7ece697
1 year ago
by seisman
0%
Merge branch 'main' into docs/shift_origin
07108e5
1 year ago
by seisman
0%
Merge branch 'main' into docs/shift_origin
9c8c878
1 year ago
by seisman
0%
Merge branch 'main' into docs/shift_origin
c3dad67
1 year ago
by seisman
0%
Rewrap to 88 characters
1148c88
1 year ago
by seisman
© 2025 CodSpeed Technology
Home Terms PrivacyDocs