fair-software / howfairis

Command line tool to analyze a GitHub or GitLab repository's compliance with the fair-software.eu recommendations
https://pypi.org/project/howfairis/
Apache License 2.0
55 stars 22 forks source link

Rst parse warnings #320

Open sverhoeven opened 3 years ago

sverhoeven commented 3 years ago

When I run

howfairis https://github.com/fair-software/fairtally
Checking compliance with fair-software.eu...
url: https://github.com/fair-software/fairtally
:7: (ERROR/3) Error parsing content block for the "list-table" directive: uniform two-level bullet list expected, but row 9 does not contain the same number of items as row 1 (1 vs 2).

.. list-table::
   :widths: 25 25
   :header-rows: 1

   * - fair-software.nl recommendations
     - Badges
   * - \1. Code repository
     - |GitHub Badge|
   * - \2. License
     - |License Badge|
   * - \3. Community Registry
     - |PyPI Badge| |Research Software Directory Badge|
   * - \4. Enable Citation
     - |Zenodo Badge|
   * - \5. Checklist
     - |CII Best Practices Badge|
   * - **Other best practices**
     -
   * - Continuous integration
     - |Python Build| |PyPI Publish|
   * - |DockerHub| |dockerhub badge|
(1/5) repository
      ✓ has_open_repository
(2/5) license
      ✓ has_license
(3/5) registry
      × has_ascl_badge
      × has_bintray_badge
      × has_conda_badge
      × has_cran_badge
      × has_crates_badge
      × has_maven_badge
      × has_npm_badge
      ✓ has_pypi_badge
      ✓ has_rsd_badge
      × is_on_github_marketplace
(4/5) citation
      × has_citation_file
      ✓ has_citationcff_file
      × has_codemeta_file
      × has_zenodo_badge
      ✓ has_zenodo_metadata_file
(5/5) checklist
      × has_core_infrastructures_badge

Calculated compliance: ● ● ● ● ○

It seems you have not yet added the fair-software.eu badge to your README.rst. You can do so by pasting the following snippet:

.. image:: https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow
   :target: https://fair-software.eu

The warnings from parsing README.rst obscure the howfairis output. Also output does not say which file these warnings belong to.

Can we suppress the warnings?