Skip to content

[JOSS Review] Suggested edits in documentation #93

@marcsit

Description

@marcsit

Please consider the following feedback for the documentation:

  • Zenodo citation link is broken: https://zenodo.org/badge/latestdoi/88457986
  • Adding a link or reference to the CRS definition: https://docs.qgis.org/3.40/en/docs/gentle_gis_introduction/coordinate_reference_systems.html
  • Considering having self-consistent code snippet in the documentation. As of now some blocks start from the package import and other blocks don't, given the relatively short numbers of lines of code and to make it easier I would consider self-contained snippets, or at least a continuous script in the successive snippets.
  • Further document how to edit the plots by using matlplotlib methods, i.e. adding a grid, updating the title, etc.
  • Provide some contextual information on the fact that the crater tables you are using are following the PDS format and that these tables are available in PDS archives such as the Lunar Crater Database that you provide.
  • Provide at least one benchmark on the performance with large data sets -such as the one in the example. You could use the timeit package and then also provide your Memory/CPU:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions