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.

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

Status of the documentation #304

Closed
CaliViking opened this issue Feb 26, 2023 · 1 comment · Fixed by #308
Closed

Status of the documentation #304

CaliViking opened this issue Feb 26, 2023 · 1 comment · Fixed by #308

Comments

@CaliViking
Copy link

Hi

Thanks for creating this crate. I know it is a tough job to create and maintain open-source software.

I wish that I understood this crate better so that I could help you with the documentation.

Some of the documentation needs some more details. For instance, I have been trying to find out how to set defaults in the code before loading from a file. It looks like the deserializer in init_file(path, deserializers) should be the place to put the code, but I cannot find out how to do it.

Just as an example, take a look at this documentation https://docs.rs/log4rs/latest/log4rs/append/struct.AppenderConfig.html - what does "Configuration for an appender" mean? How am I supposed to use it? What are the options for the appender kind? What is filter and config? Just a few more sentences that describe the intent would help a lot.

Please let me know if there is any way that I can help. I don't want to be criticizing the crate, it does a lot of good. Thank you for creating it.

@bconn98
Copy link
Collaborator

bconn98 commented Apr 1, 2023

Hello! I've just submitted a PR that may help with some of your issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants