Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

145 améliorer laide des fonctions lien vers doc shiny #153

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

145 améliorer laide des fonctions lien vers doc shiny #153

wants to merge 5 commits into from

Conversation

jengelaere
Copy link
Contributor

@jengelaere jengelaere commented Nov 21, 2023 •
edited
Loading

  • Est-ce que mon code respecte les standards de qualité de mise en production de packages ?
  • Est-ce que la personne qui révise à toutes les informations pour valider les fonctionnalités / résolutions de problèmes sans trop de recherches ?
  • Est-ce que le client qui validera les tickets associés à les informations pour le faire sans perte de temps ?

Issues à faire valider pour fermer :

  • issue #

Issues traitées à garder ouvertes ou en cours :

  • issue #

Checklist:

  • Est-ce que le check du package passe en local ?
  • Est-ce que le CI passe ?
  • Est-ce que les fonctionnalités ajoutées / corrigées, sont documentées, testées ?
  • Est-ce que les fonctionnalités ajoutées / problèmes résolus sont brièvement présentées dans le message de la MR ?
  • Est-ce que les modifications sont liées à des tickets / issues que j'ai listés dans les commits et dans la MR elle-même ?
  • Est-ce que les tickets sont en mode "révision" dans le Board de suivi du projet ?
  • Est-ce que chaque ticket, s'il doit être fermé après acceptation de la MR contient un commentaire qui dit comment le valider ?

@lisaSMAH
J'ai inclus des liens vers la documentation Shiny uniquement pour les…
7b4b6aa 
… fonctions qui ont des équivalents dans la bibliothèque Shiny d'origine. Cela signifie que les utilisateurs trouveront des liens vers l'aide Shiny uniquement pour les fonctions pour lesquelles j'ai pu identifier des correspondances.
@lisaSMAH
Pour le premier critère, j'ai inclus des liens vers la documentation …
eb22e3c 
…Shiny uniquement pour les fonctions qui ont des équivalents dans la bibliothèque Shiny d'origine. Cela signifie que les utilisateurs trouveront des liens vers l'aide Shiny uniquement pour les fonctions pour lesquelles j'ai pu identifier des correspondances. En ce qui concerne le deuxième critère, je cherche un exemple concret pour illustrer ces différences.
@lisaSMAH
#145 Ajout des liens vers les fonctions Shiny correspondantes.
cd27995
@jengelaere jengelaere linked an issue Nov 21, 2023 that may be closed by this pull request
Améliorer l'aide des fonctions lien vers doc shiny #145
Open
2 tasks
@codecov-commenter
Copy link

codecov-commenter commented Dec 8, 2023 •
edited
Loading

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (c62ca5a) 77.59% compared to head (5789bb3) 77.85%.
Report is 11 commits behind head on main.

❗ Current head 5789bb3 differs from pull request most recent head 38ed324. Consider uploading reports for the commit 38ed324 to get more accurate results

Files Patch % Lines
R/app_ui.R 0.00% 1 Missing ⚠️
R/use_favicon_dsfr.R 88.88% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #153      +/-   ##
==========================================
+ Coverage   77.59%   77.85%   +0.25%     
==========================================
  Files          67       68       +1     
  Lines        1558     1576      +18     
==========================================
+ Hits         1209     1227      +18     
  Misses        349      349

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jengelaere
Copy link
Contributor Author

@edouard-morin
Pourras-tu reprendre ça tant que tu es sur shinygouv :
idéalement, tous les liens externes proposés par Lisa doivent être remplacé par des liens internes pour que l'utilisateur voit l'aide lié à se version de shiny (prise de tête assurée si différences).
La syntaxe est :
[shiny::fonction_shiny_origine()]
d'après https://stackoverflow.com/questions/25489042/linking-to-other-packages-in-documentation-in-roxygen2-in-r

@edouard-morin
Copy link
Collaborator

Les liens sur withSpinner et radioGroupButtons font références à des packages non implémenté avec shinygouv, on ne peut donc pas faire de référence interne. De plus , pour les fonctions entièrement réécrite , y a t-il un intérêt à orienter sur une documentation qui ne concerne pas la fonction shinygouv (même si elle s'en inspire). Ce type de référence pourrait se limiter aux cas ma_fonction_dsfr <- shiny::ma_fonction

@jengelaere
Copy link
Contributor Author

En plus [shiny::withProgress()] est déjà citée dans l'aide de withSpinner_dsfr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Améliorer l'aide des fonctions lien vers doc shiny
4 participants
@jengelaere @codecov-commenter @edouard-morin @lisaSMAH