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

Fix documentation of Timber.Tree.log() params #207

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

vaughandroid
Copy link

No description provided.

Copy link
Contributor

@vanniktech vanniktech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think we need this anymore since this method got the @Nullable and @NotNull annotation and hence this could be closed.

@realdadfish
Copy link

@vanniktech Yes, the annotations are now in place, however, that the stacktrace of a throwable - if present - is always attached to the message is still worth documenting IMHO. I don't know what lead to this decision, as it kind of makes giving the Throwable as argument superfluous (and impossible to easily separate the original log message from the exception's trace), but well. I'd have expected - on this level - that if no message was given that just the message, but not the whole stack trace of an exception would have been put into the message.

@tschuchortdev
Copy link

@vanniktech It's been 2 years, why has this not been merged yet? Leaving the misleading documentation like this is just bikeshedding.

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 this pull request may close these issues.

None yet

5 participants