Fix API doc examples that depend on local files #340
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wch
reviewed
Sep 30, 2022
docs/sphinxext/pyshinyapp.py
Outdated
Comment on lines
56
to
58
| with open(f, "rb") as x: | ||
| fc = base64.b64encode(x.read()).decode("utf-8") | ||
| code += f"\n\n## file: {os.path.basename(f)}\n## type: binary\n{fc}" |
Collaborator
There was a problem hiding this comment.
I don't think this should encode all files as binary. Text files shouldn't be base64 encoded -- that will work, but it'll make the file non-editable in the editor, and the content will also not be viewable.
Here's some code I used in shinylive to attempt reading as text, and if that fails, read as binary. It would make sense to do something similar here.
https://github.com/rstudio/py-shinylive/blob/486f9f9f7f54cb129b95c0122716990a40d66ed3/shinylive/_app_json.py#L73-L82
wch
requested changes
Sep 30, 2022
Collaborator
wch
left a comment
wch
left a comment
There was a problem hiding this comment.
One issue here: the files should only be encoded as binary if they're actually binary files. Otherwise, looks good!
wch
force-pushed
the
add-example-files
branch
from
0aeacd2 to
3c43cd0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #240
Closes #330
Also adds
output_tableandrender.tableto the API reference