Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation errors in README and Javadoc #91

Closed
jstuyts opened this issue May 15, 2020 · 0 comments · Fixed by #92
Closed

Documentation errors in README and Javadoc #91

jstuyts opened this issue May 15, 2020 · 0 comments · Fixed by #92
Assignees
@chingor13
Labels
api: logging Issues related to the googleapis/java-logging-logback API. cla: yes This human has signed the Contributor License Agreement. documentation Improvements or additions to documentation type: docs Improvement to the documentation for an API.

Comments

@jstuyts
Copy link
Contributor

jstuyts commented May 15, 2020

The README uses an old version, but 0.117.0 is available.

The example configurations are a bit hard to read because:

  • The comments are at different locations.
  • Javadoc uses a list instead of a code block.

The Javadoc incorrectly states that there is a level tag that can be used to filter, but you have to use a filter tag (as is correctly shown in the README).
@product-auto-label product-auto-label bot added the api: logging Issues related to the googleapis/java-logging-logback API. label May 15, 2020
@jstuyts jstuyts mentioned this issue May 15, 2020
Merged
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels May 15, 2020
@simonz130 simonz130 added cla: yes This human has signed the Contributor License Agreement. documentation Improvements or additions to documentation and removed triage me I really want to be triaged. labels Jun 9, 2020
@yoshi-automation yoshi-automation added the triage me I really want to be triaged. label Jun 9, 2020
@chingor13 chingor13 added the type: docs Improvement to the documentation for an API. label Jun 10, 2020
@yoshi-automation yoshi-automation removed 🚨 This issue needs some love. triage me I really want to be triaged. labels Jun 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chingor13 chingor13

Labels
api: logging Issues related to the googleapis/java-logging-logback API. cla: yes This human has signed the Contributor License Agreement. documentation Improvements or additions to documentation type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: Documentation: version number and usage squins/java-logging-logback
4 participants
@chingor13 @jstuyts @simonz130 @yoshi-automation