Provide proper SDK Documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza comparando las descripciones de campos generadas por el Python SDK con el ejemplo del Go SDK enlazado en el issue. Identifica el punto de entrada de la generación de documentación y el alcance de los modelos de API afectados; el trabajo estará terminado cuando los usuarios de Python reciban descripciones significativas de las propiedades en lugar de texto de marcador de posición repetido.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I see that the go SDK has great API documentation (example).
The python SDK only provides rather useless text parts:
The value to assign to XXX of this YYY.
It would be great if also the python folks can benefit from good documentation.
Thanks!
- Lenguaje dominante
- Python
- Estrellas
- 474
- Forks
- 321
- Merge medio
- 23 min
- PR fusionados (30 d)
- 4
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 oracle/oci-python-sdk
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
oracle/oci-python-sdk#890 · 3 comentarios ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
oracle/oci-python-sdk#879 · 3 comentarios ·
-
Example uses non-existent API Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 66/100
oracle/oci-python-sdk#878 ·
-
SDK
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
oracle/oci-python-sdk#861 · 5 comentarios ·
-
SDK
Dificultad 2/5 1-3 horas Aptitud para principiantes 48/100
oracle/oci-python-sdk#852 ·
Todos los issues de oracle/oci-python-sdk
Issues similares
-
[Bug] reef-hermes tells me to resume with hermes --resume, which does not work from my shell Abiertoarea: harness bug status: needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Human-Agent-Society/reef#625 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
learningequality/kolibri#15351 · 2 comentarios ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Name consistency Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
eellak/triplestore#65 · 1 comentario ·