Documentar os métodos.

[esron]

Precisamos de sua ajuda pra documentar os métodos.

• Escolha um método
• Adicione a assinatura dele de acordo com os exemplos no README.md
• Descreva os usos do método

[ayrtonvwf]

Olá. Gostaria de contribuir com essa issue.
Por "adicionar a assinatura" dos métodos, se refere à adicionar os comentários dos métodos em phpDoc? Ou/e seria adicionar os tipos de parâmetros e retornos das funções diretamente no código?
Caso seja para adicionar os tipos diretamente no código, qual a menor versão de PHP suportada?

[esron]

Olá @ayrtonvwf , é bem simples mesmo, só adicionar ao README um exemplo de uso, como o que já tem lá. Não há necessidade de adicionar ao código.

[ayrtonvwf]

Entendi.
Como estava fácil aqui (minha IDE ajudou bastante), adicionei comentários como phpDoc, que vão ajudar os desenvolvedores que forem utilizar esses métodos.
Com essas anotações, as outras IDEs vão autocompletar e sugerir o uso dos métodos e parâmetros certos com mais facilidade.
Sinta-se livre para aceitar ou rejeitar a PR se achar útil.

[ayrtonvwf]

Também adicionei documentação de alguns métodos. Uma parte deles não tive certeza de como funcionavam, então preferi não criar uma documentação incorreta.

[esron]

@ayrtonvwf Muito obrigado, já aceitei seu merge 👍