docs/shift_origin - Branch - GenericMappingTools/pygmt

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

#2879Merged

Comparing

docs/shift_origin

(

1148c88

) with

main

(

e0593d2

)

Untouched: 64

Benchmarks

Passed

test_grdlandmask_no_outgrid

pygmt/tests/test_grdlandmask.py::test_grdlandmask_no_outgrid

+4%

153 ms147.5 ms

test_sph2grd_no_outgrid

pygmt/tests/test_sph2grd.py::test_sph2grd_no_outgrid

+2%

415.7 ms406.2 ms

test_sphinterpolate_no_outgrid

pygmt/tests/test_sphinterpolate.py::test_sphinterpolate_no_outgrid

74.1 ms73.8 ms

test_io_load_dataarray

pygmt/tests/test_io.py::test_io_load_dataarray

26 ms25.9 ms

test_text_multiple_lines_of_text

pygmt/tests/test_text.py::test_text_multiple_lines_of_text

19.6 ms19.5 ms

test_makecpt_output_cpt_file

pygmt/tests/test_makecpt.py::test_makecpt_output_cpt_file

11.8 ms11.8 ms

test_grdcontour_labels

pygmt/tests/test_grdcontour.py::test_grdcontour_labels

19.3 ms19.2 ms

test_basemap

pygmt/tests/test_basemap.py::test_basemap

15.7 ms15.7 ms

test_surface_input_xyz

pygmt/tests/test_surface.py::test_surface_input_xyz

25.4 ms25.3 ms

test_grdgradient_no_outgrid

pygmt/tests/test_grdgradient.py::test_grdgradient_no_outgrid

17.7 ms17.7 ms

test_grdcut_dataarray_in_dataarray_out

pygmt/tests/test_grdcut.py::test_grdcut_dataarray_in_dataarray_out

17.6 ms17.6 ms

test_timestamp_font

pygmt/tests/test_timestamp.py::test_timestamp_font

15.7 ms15.7 ms

test_plot_vectors

pygmt/tests/test_plot.py::test_plot_vectors

16.7 ms16.7 ms

test_project_input_matrix[DataFrame]

pygmt/tests/test_project.py::test_project_input_matrix[DataFrame]

9.5 ms9.5 ms

test_legend_entries

pygmt/tests/test_legend.py::test_legend_entries

127.9 ms127.8 ms

test_grdtrack_input_dataframe_and_dataarray

pygmt/tests/test_grdtrack.py::test_grdtrack_input_dataframe_and_dataarray

9.9 ms9.9 ms

test_plot3d_vectors

pygmt/tests/test_plot3d.py::test_plot3d_vectors

17.1 ms17.1 ms

test_velo_pandas_dataframe

pygmt/tests/test_velo.py::test_velo_pandas_dataframe

21.9 ms21.9 ms

test_rose_plot_data_using_cpt

pygmt/tests/test_rose.py::test_rose_plot_data_using_cpt

18.2 ms18.2 ms

test_psconvert

pygmt/tests/test_psconvert.py::test_psconvert

25.8 ms25.8 ms

test_grdclip_no_outgrid

pygmt/tests/test_grdclip.py::test_grdclip_no_outgrid

17.7 ms17.7 ms

test_project_input_matrix[array]

pygmt/tests/test_project.py::test_project_input_matrix[array]

9.2 ms9.2 ms

test_select_input_dataframe

pygmt/tests/test_select.py::test_select_input_dataframe

34.7 ms34.7 ms

test_solar_set_terminator_datetime[terminator_datetime1]

pygmt/tests/test_solar.py::test_solar_set_terminator_datetime[terminator_datetime1]

25.2 ms25.1 ms

test_meca_spec_multiple_focalmecha[dict_mecha]

pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[dict_mecha]

32.3 ms32.2 ms

test_subplot_basic_frame

pygmt/tests/test_subplot.py::test_subplot_basic_frame

62.9 ms62.9 ms

test_compute_bins_no_outfile

pygmt/tests/test_grdhisteq.py::test_compute_bins_no_outfile

10.5 ms10.5 ms

test_inset_aliases

pygmt/tests/test_inset.py::test_inset_aliases

567.8 ms567.6 ms

test_regular_grid_no_outgrid

pygmt/tests/test_triangulate.py::test_regular_grid_no_outgrid

77.1 ms77.1 ms

test_meca_spec_multiple_focalmecha[array2d]

pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[array2d]

31.1 ms31 ms

test_geopandas_info_geodataframe

pygmt/tests/test_geopandas.py::test_geopandas_info_geodataframe

24.9 ms24.8 ms

test_grdfill_dataarray_out

pygmt/tests/test_grdfill.py::test_grdfill_dataarray_out

17.6 ms17.6 ms

test_grd2cpt

pygmt/tests/test_grd2cpt.py::test_grd2cpt

41.5 ms41.5 ms

test_begin_end

pygmt/tests/test_session_management.py::test_begin_end

35.3 ms35.3 ms

test_nearneighbor_input_xyz

pygmt/tests/test_nearneighbor.py::test_nearneighbor_input_xyz

1.4 s1.4 s

test_grdview_drapegrid_dataarray

pygmt/tests/test_grdview.py::test_grdview_drapegrid_dataarray

1.3 s1.3 s

test_sphdistance_no_outgrid

pygmt/tests/test_sphdistance.py::test_sphdistance_no_outgrid

148.9 ms148.9 ms

test_wiggle_data_incols

pygmt/tests/test_wiggle.py::test_wiggle_data_incols

16.3 ms16.3 ms

test_meca_spec_multiple_focalmecha[dict_mecha_mixed]

pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[dict_mecha_mixed]

32.3 ms32.3 ms

test_grdfilter_dataarray_in_dataarray_out

pygmt/tests/test_grdfilter.py::test_grdfilter_dataarray_in_dataarray_out

17.8 ms17.8 ms

test_project_input_matrix[Dataset]

pygmt/tests/test_project.py::test_project_input_matrix[Dataset]

11.3 ms11.3 ms

test_delaunay_triples_input_xyz

pygmt/tests/test_triangulate.py::test_delaunay_triples_input_xyz

44.8 ms44.8 ms

test_which_multiple

pygmt/tests/test_which.py::test_which_multiple

13.8 ms13.8 ms

test_grdimage_grid_and_shading_with_xarray[png]

pygmt/tests/test_grdimage.py::test_grdimage_grid_and_shading_with_xarray[png]

1.3 s1.3 s

test_solar_set_terminator_datetime[terminator_datetime_string]

pygmt/tests/test_solar.py::test_solar_set_terminator_datetime[terminator_datetime_string]

25.9 ms25.9 ms

test_meca_spec_multiple_focalmecha[dataframe]

pygmt/tests/test_meca.py::test_meca_spec_multiple_focalmecha[dataframe]

31.7 ms31.8 ms

test_grdinfo

pygmt/tests/test_grdinfo.py::test_grdinfo

8 ms8 ms

test_x2sys_init_units_gap

pygmt/tests/test_x2sys_init.py::test_x2sys_init_units_gap

11.4 ms11.4 ms

test_x2sys_cross_input_dataframe_output_dataframe

pygmt/tests/test_x2sys_cross.py::test_x2sys_cross_input_dataframe_output_dataframe

25 ms25 ms

test_equalize_grid_no_outgrid

pygmt/tests/test_grdhisteq.py::test_equalize_grid_no_outgrid

17.7 ms17.7 ms

test_histogram[list]

pygmt/tests/test_histogram.py::test_histogram[list]

16 ms16 ms

test_grdvolume_no_outgrid

pygmt/tests/test_grdvolume.py::test_grdvolume_no_outgrid

9.5 ms9.5 ms

test_xyz2grd_input_array[array]

pygmt/tests/test_xyz2grd.py::test_xyz2grd_input_array[array]

48.9 ms49 ms

test_ternary_3_labels

pygmt/tests/test_ternary.py::test_ternary_3_labels

27.1 ms27.2 ms

test_grd2xyz

pygmt/tests/test_grd2xyz.py::test_grd2xyz

9.7 ms9.7 ms

test_xyz2grd_input_array[Dataset]

pygmt/tests/test_xyz2grd.py::test_xyz2grd_input_array[Dataset]

46.4 ms46.6 ms

test_info_pandas_dataframe_date_column[datetime64[ns]]

pygmt/tests/test_info.py::test_info_pandas_dataframe_date_column[datetime64[ns]]

12.7 ms12.7 ms

test_histogram[Series]

pygmt/tests/test_histogram.py::test_histogram[Series]

16 ms16.1 ms

test_info_xarray_dataset_time_column

pygmt/tests/test_info.py::test_info_xarray_dataset_time_column

12.8 ms12.9 ms

test_logo

pygmt/tests/test_logo.py::test_logo

-1%

177.4 ms178.3 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]

-1%

21.1 ms21.4 ms

test_grdproject_no_outgrid[M10c]

pygmt/tests/test_grdproject.py::test_grdproject_no_outgrid[M10c]

-1%

20.7 ms21 ms

test_grdproject_no_outgrid[EPSG:3395 +width=10]

pygmt/tests/test_grdproject.py::test_grdproject_no_outgrid[EPSG:3395 +width=10]

-2%

21.2 ms21.5 ms

test_grdsample_dataarray_out

pygmt/tests/test_grdsample.py::test_grdsample_dataarray_out

-2%

19.1 ms19.4 ms

Commits

Click on a commit to change the comparison range

Base

main

e0593d2

+0.03%

Merge branch 'main' into docs/shift_origin

0f8744c

2 years ago

by seisman

+21.17%

Rewrap to 88 characters

c325925

2 years ago

by seisman

-21.38%

Explicitly set shift unit

7ece697

2 years ago

by seisman

-0.01%

Merge branch 'main' into docs/shift_origin

07108e5

2 years ago

by seisman

+0.19%

Merge branch 'main' into docs/shift_origin

9c8c878

2 years ago

by seisman

+0.05%

Merge branch 'main' into docs/shift_origin

c3dad67

2 years ago

by seisman

-0.07%

Rewrap to 88 characters

1148c88

2 years ago

by seisman

Home Terms Privacy Docs