Skip to content

Move all code snippet in reference documentation to actual code #23574

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

Closed
snicoll opened this issue Oct 2, 2020 · 1 comment
Closed

Move all code snippet in reference documentation to actual code #23574

snicoll opened this issue Oct 2, 2020 · 1 comment
Labels
status: duplicate A duplicate of another issue type: documentation A documentation update

Comments

@snicoll
Copy link
Member

snicoll commented Oct 2, 2020

Our reference guide has a mix and match of code snippets and actual code that's imported in the reference documentation. To make sure code snippet stays accurate in case of an API change, we'd like to make sure they all move to actual code that's compiled prior to reference doc generation.

This is also a prerequisite for adding a Kotlin variant alongside the Java examples we have at the moment.

@snicoll snicoll added the type: documentation A documentation update label Oct 2, 2020
@snicoll snicoll added this to the 2.x milestone Oct 2, 2020
@snicoll
Copy link
Member Author

snicoll commented Oct 2, 2020

Gah. We already have an issue for this. Sorry for the noise.

Duplicate of #6313

@snicoll snicoll closed this as completed Oct 2, 2020
@snicoll snicoll added the status: duplicate A duplicate of another issue label Oct 2, 2020
@snicoll snicoll removed this from the 2.x milestone Oct 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: duplicate A duplicate of another issue type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

1 participant