Make it clear which client methods do not make an API call

Aberta Para iniciantes
#196 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
68/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Comece lendo os métodos do cliente em client.py, incluindo Client.folder() e Client.file(), e depois verifique o uso correspondente no README ou na documentação da API. Atualize o README e as docstrings dos métodos para que indiquem claramente que esses métodos inicializam objetos vazios sem fazer uma chamada à API por padrão; considera-se concluído quando ambos os locais comunicarem esse comportamento.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement

In both the README and in client.py, it isn't made clear that Client.folder(), Client.file(), etc. do not make an API call by default (they initialize an empty object, which can then be used to make API calls).

We should call this out, both in the README, and in the docstrings of those methods.

Linguagem predominante
Python
Estrelas
460
Forks
223
Merge médio
14h 18min
PRs com merge (30d)
21

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.

Mais de box/box-python-sdk

Todas as issues de box/box-python-sdk

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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