From 5213656cfaa2aaf03191d989f5365667c49a5623 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sim=C3=A3o=20Bolota?= Date: Tue, 24 Jan 2023 16:21:39 +0000 Subject: [PATCH 1/2] Update README.md --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1550db12..4ac28434 100644 --- a/README.md +++ b/README.md @@ -82,19 +82,21 @@ Additionally, the recommended file locations for each metadata are suggested in Below you can find a table with the Napari recommended file locations and fallback files where the metadata is checked: -| Metadata / Files | Recommended File | Fallback File(s) | -| ----------------- | --------------------------- | ------------ | -| Display Name | `npe2 - napari.manifest` | `PyPI` | -| Summary Sentence | `napari-hub/config.yml` | `PyPI` | -| Intro Paragraph | `napari-hub/description.md` | `PyPI` | -| Intro Video | `napari-hub/description.md` | `PyPI` | -| Intro Screenshot | `napari-hub/description.md` | `PyPI` | -| Usage Section | `napari-hub/description.md` | `PyPI` | -| Source Code Link | `PyPI` | `n/a` | -| User Support Link | `PyPI` | `n/a` | -| Bug Tracker Link | `PyPI` | `n/a` | -| Author | `PyPI` | `n/a` | -| Citation | `CITATION.cff` | `n/a` | +| Metadata / Files | Recommended File | Fallback File(s) | +| ------------------- | ------------------------------- | ---------------- | +| Display Name | ```npe2 - napari.manifest``` | ```PyPI``` | +| Summary Sentence | ```napari-hub/config.yml``` | ```PyPI``` | +| Intro Paragraph | ```napari-hub/description.md``` | ```PyPI``` | +| Intro Video | ```napari-hub/description.md``` | ```PyPI``` | +| Intro Screenshot | ```napari-hub/description.md``` | ```PyPI``` | +| Usage Section | ```napari-hub/description.md``` | ```PyPI``` | +| Installation Section| ```napari-hub/description.md``` | ```PyPI``` | +| Source Code Link | ```PyPI``` | ```n/a``` | +| User Support Link | ```PyPI``` | ```n/a``` | +| Bug Tracker Link | ```PyPI``` | ```n/a``` | +| Author | ```PyPI``` | ```n/a``` | +| Citation | ```CITATION.cff``` | ```n/a``` | + Example output (with all possible scenarios): From 7e26dccb254dca3c3bfb7754b983e8ee1a5e4c27 Mon Sep 17 00:00:00 2001 From: Sean Martin Date: Tue, 31 Jan 2023 20:59:25 +0000 Subject: [PATCH 2/2] Fix typo of bewteen to between --- napari_hub_cli/citation.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/napari_hub_cli/citation.py b/napari_hub_cli/citation.py index c49556f7..4bb2498d 100644 --- a/napari_hub_cli/citation.py +++ b/napari_hub_cli/citation.py @@ -96,7 +96,7 @@ def scrap_users(local_repo): else: authors.append( { - "given-names": f"{name} # We cannot split your name automatically bewteen 'given-names' and 'family-names', we apologize for that. Please do it manually", + "given-names": f"{name} # We cannot split your name automatically between 'given-names' and 'family-names', we apologize for that. Please do it manually", } ) return {"authors": authors}