plotly / plotly/plotly.py

Full python docstring not included in web API docs

Abierto
#4,205 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@LiamConnors ya está trabajando en esto.

Desde el 11/7/2024.

bug documentation P3
Lenguaje dominante
Python
Estrellas
18.8k
Forks
2.8k
Merge medio
16 h 26 min
PR fusionados (30 d)
21

Descripción

It looks like only the first section in the python docstring is included in the API docs?

If you look at the documentation for e.g. Cone:

anchor – Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.

(This is nonsense: What is "cm"? What is the datatype and allowed input for anchor?)

But cone.py contains a docstring with more content:

    def anchor(self):
        """
        Sets the cones' anchor with respect to their x/y/z positions.
        Note that "cm" denote the cone's center of mass which
        corresponds to 1/4 from the tail to tip.

        The 'anchor' property is an enumeration that may be specified as:
          - One of the following enumeration values:
                ['tip', 'tail', 'cm', 'center']

        Returns
        -------
        Any
        """

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.