plotly / plotly/plotly.py

Full python docstring not included in web API docs

Aberta
#4,205 0 comentários 0 reações 1 responsável Ver no GitHub

@LiamConnors já está trabalhando nisso.

Desde 11/7/2024.

bug documentation P3
Linguagem predominante
Python
Estrelas
18.8k
Forks
2.8k
Merge médio
16h 26min
PRs com merge (30d)
21

Descrição

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
        """

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.