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

[Java] Improve Fury Logger documentation. #1497

Open
LiangliangSui opened this issue Apr 11, 2024 · 0 comments
Open

[Java] Improve Fury Logger documentation. #1497

LiangliangSui opened this issue Apr 11, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@LiangliangSui
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Fury Logger is optional between FuryLogger and Slf4jLogger, or disable Fury log completely.

Describe the solution you'd like

We should improve the usage documentation in java_object_graph_guide.md.

In addition, we should also improve the LoggerFactory javadoc.

Additional context

Logger related PR
@LiangliangSui LiangliangSui added the enhancement New feature or request label Apr 11, 2024
@LiangliangSui LiangliangSui mentioned this issue Apr 14, 2024
Merged
2 tasks
chaokunyang pushed a commit that referenced this issue Apr 14, 2024
@LiangliangSui
chore(java): Improve javadoc for logging module. (#1509)
2197602 
<!--
**Thanks for contributing to Fury.**

**If this is your first time opening a PR on fury, you can refer to
[CONTRIBUTING.md](https://github.com/apache/incubator-fury/blob/main/CONTRIBUTING.md).**

Contribution Checklist

- The **Apache Fury (incubating)** community has restrictions on the
naming of pr titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/incubator-fury/blob/main/CONTRIBUTING.md).

- Fury has a strong focus on performance. If the PR you submit will have
an impact on performance, please benchmark it first and provide the
benchmark result here.
-->

## What does this PR do?

<!-- Describe the purpose of this PR. -->
Improve javadoc for logging module.

## Related issues

<!--
Is there any related issue? Please attach here.

- #xxxx0
- #xxxx1
- #xxxx2
-->
#1497

## Does this PR introduce any user-facing change?

<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/incubator-fury/issues/new/choose)
describing the need to do so and update the document if necessary.
-->

- [ ] Does this PR introduce any binary protocol compatibility change?

- [ ] Does this PR introduce any public API change?

## Benchmark

<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
-->

---------

Signed-off-by: LiangliangSui <coolsui.coding@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@LiangliangSui