Fixed words replacement logic in documentation codegen breaks hyperlinks
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Reproduce el problema comprobando la ayuda de RFSG select_arb_waveform y comparando los archivos class.rst y session.py generados. Empieza con la lógica de reemplazo de palabras fijas del asistente de documentación. La tarea estará terminada cuando los cambios de terminología se apliquen al texto normal, mientras los destinos de los hipervínculos permanezcan sin cambios y los enlaces generados sean válidos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description of issue
We are replacing words like attributes with properties in documentation helper in an effort to standardize on these terminologies. This logic ends up changing the text in hyperlinks as well. The codegen should somehow know to skip the hyperlinks while doing this replacing.
System report
Steps to reproduce issue
If any API has a hyperlink in its documentation which contains words like attribute, then the generated class.rst and session.py will show a broken hyperlink.
Check help of select_arb_waveform function in RFSG.
- Lenguaje dominante
- Python
- Estrellas
- 128
- Forks
- 110
- Merge medio
- 5 d 14 h
- PR fusionados (30 d)
- 10
Guía de contribución
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.
Más de ni/nimi-python
-
docs nitclk priority-low
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
ni/nimi-python#1993 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
ni/nimi-python#2164 · 1 comentario ·
-
bug docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 48/100
ni/nimi-python#2162 ·
-
codegen enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 42/100
ni/nimi-python#2148 · 2 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
ni/nimi-python#2122 ·
Todos los issues de ni/nimi-python
Issues similares
-
agent-ready documentation needs-triage
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
-
Add https://search.jeremyh.xyz/ Abiertoinstance instance add
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
searxng/searx-instances#939 · 1 comentario ·
-
area-deployment area-integrations triage:bot-seen
Dificultad 2/5 Medio día Aptitud para principiantes 86/100