OpenFeign/feign

Update Java Doc

Open

Aperta il 16 ago 2018

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Java (9070 star) (1911 fork)batch import
documentationhelp wanted

Descrizione

The current set of Java Doc is old and in some cases, misleading. Also, during a release, there are a number of items missing.

Guida contributor

Tech stack
java
Dominio
documentationapi
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
needs investigation
Prerequisiti
JavaJavaDoc knowledgefamiliarity with Feign
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
Start by identifying the current JavaDoc files in the repository. Compare with the actual behavior of the code, noting any outdated or misleading parts. Look at recent commits and release notes to see what features or changes are missing from the documentation. Consider adding missing JavaDoc for new classes or methods. The issue lacks specific examples, so you may need to scan the codebase and open a follow up issue if the scope is too broad.