-
Notifications
You must be signed in to change notification settings - Fork 237
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
Add MerchantRepository for holding BraintreeClient properties #1202
Conversation
* main: Update heroku server endpoints (#1198)
import androidx.annotation.RestrictTo | ||
|
||
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) | ||
class MerchantRepository { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if there's a clearer name for this class.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a doc string for our internal understanding of what this class is for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
➕ 1 I think some docstrings would help, I don't have any issues with the name since this naming seems like a common pattern on Android.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does the @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
prevent dokka from publishing to the generated docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like those internal classes do get published :(
I'll look to see if there's a way to prevent this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does the
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
prevent dokka from publishing to the generated docs?
Not sure if it does that, but you could add @suppress
in the docs to suppress it.
Also see: Kotlin/dokka#2404 for a custom implementation we can do to suppress all @RestrictTo
annotated methods.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dang, I thought there'd be support directly in Dokka for that. I've added some docs for this class.
I'll create a tech debt ticket for possibly adding a custom implementation to suppress based on the annotation.
Summary of changes
Checklist
Authors