react-navigation / react-navigation/react-navigation.github.io
Better documentation for router getScreenOptions
Abierto
Nadie ha tomado este issue todavía.
help wanted
- Lenguaje dominante
- JavaScript
- Estrellas
- 324
- Forks
- 2k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
The documentation of getScreenOptions needs some clarification:
- the headline is
getScreenOptions(navigation, screenProps)but the text explains 3 parameters. What is about navigationOptions? - The text says "retrieve the navigation options for a screen". Why the function is named screen options while it returns navigation options?
- The example code uses
addNavigationHelperswhich does not exits anymore? - For me is not clear where I can use this function, p.ex. in screen, in my custom router, etc. Please improve the example to make this more clear.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la documentación enlazada de custom-routers, en la sección getScreenOptions, y revisa su firma, explicación y ejemplo con addNavigationHelpers. Aclara los parámetros, la terminología, el uso actual de la API y dónde se utiliza la función; se considera terminado cuando el ejemplo y el texto circundante responden a cada punto sin depender de APIs obsoletas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, react-native
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100