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

Update developer documentation to explain how to use backend code #11731

Closed
mikehardy opened this issue Jun 29, 2022 · 1 comment
Closed

Update developer documentation to explain how to use backend code #11731

mikehardy opened this issue Jun 29, 2022 · 1 comment
Labels
Dev Development, testing & CI Help Wanted Requesting Pull Requests from volunteers Stale

Comments

@mikehardy
Copy link
Member

proto classes are (were?) difficult to construct from inside Java, making testing and mocking difficult

With the Kotlin extensions, creation is quite easy. Currently the only proto message in DeckPicker is OpChanges, and you could create an instance of that with the studyQueues field set using something like the following:

        val changes = opChanges {
            studyQueues = true
        }

classes were not well documented due to being autogenerated

That is true, the code protobuf-java generates does not make it very easy to see at a glance which fields are available. It does take comments from the .proto files and include them in docstrings, but those docstrings get stripped from the .class files included in the artifact. I presume Google expect people to be referencing the .proto files when they work with generated messages, and it is clearer that way, as you can see at a glance what methods are available in a given category, and how the messages relate to each other.

Originally posted by @dae in #11644 (comment)

@mikehardy mikehardy added Help Wanted Requesting Pull Requests from volunteers Dev Development, testing & CI labels Jun 29, 2022
@github-actions
Copy link
Contributor

Hello 👋, this issue has been opened for more than 2 months with no activity on it. If the issue is still here, please keep in mind that we need community support and help to fix it! Just comment something like still searching for solutions and if you found one, please open a pull request! You have 7 days until this gets closed automatically

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev Development, testing & CI Help Wanted Requesting Pull Requests from volunteers Stale
Projects
None yet
Development

No branches or pull requests

1 participant