INRIA/spoon
good first issue: add documentation for 3 undocumented public methods
开放
#1,876 创建于 2018年2月22日
documentationgood first issue
仓库指标
- 星标
- (1,933 个星标)
- PR 合并指标
- (平均合并 19天 11小时) (30 天内合并 49 个 PR)
描述
In Spoon, we want that all public methods are properly documented.
We have a test case to check this: https://github.com/INRIA/spoon/blob/51c4b2211922e71914f74ce4341a6232c079f174/src/test/java/spoon/test/architecture/SpoonArchitectureEnforcerTest.java#L120
This test case temporarily skips small methods.
To get this issue done:
- List the undocumented public methods:
- lower the threshold
size() > 33in the test case - run the test case, this will list you undocumented public methods
- lower the threshold
- Add appropriate Javadoc documentation
/** .... */ - Create a pull request with your changes