fix(colabs): Update docs for Report API #357
Closed
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
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
The following colabs where changed |
ngrayluna
reviewed
Jan 13, 2023
Contributor
ngrayluna
left a comment
ngrayluna
left a comment
There was a problem hiding this comment.
Missing commas, didn't catch them all. Found them mainly in the 'description' parameters .
| "## Quick Links\n", | ||
| "- [🚀 Quickstart Guide](#quickstart) (~5min)\n", | ||
| "- [❓ FAQ](#faq)\n", | ||
| "- [📌 Complete Examples](#complete_examples)" |
Contributor
There was a problem hiding this comment.
The "complete_examples" html ID doesn't work. Changing it from #complete_examples to #complete worked.
| }, | ||
| "source": [ | ||
| "## I tried mutating an object in list but it didn't work!\n", | ||
| "tl;dr: It should always work if you assign a value to the attribute instead of mutating. If you really need to mutate, do it before assignment.\n", |
Contributor
There was a problem hiding this comment.
Remove "TL;DR". Not all customers will know what that means (especially ESL folks).
| "source": [ | ||
| "report = wr.Report(\n", | ||
| " PROJECT,\n", | ||
| " title=\"Resizing panels\"\n", |
| "report = wr.Report(\n", | ||
| " PROJECT,\n", | ||
| " title='W&B Block Gallery',\n", | ||
| " description=\"Check out all of the blocks available in W&B\"\n", |
| "report = wr.Report(\n", | ||
| " project=PROJECT,\n", | ||
| " title='W&B Panel Gallery',\n", | ||
| " description=\"Check out all of the panels available in W&B\"\n", |
| "source": [ | ||
| "report = wr.Report(PROJECT,\n", | ||
| " title=\"Report with links\",\n", | ||
| " description=\"Use `wr.Link(text, url)` to add links inside normal text, or use normal markdown syntax in a MarkdownBlock\"\n", |
| "report3 = wr.Report(\n", | ||
| " PROJECT,\n", | ||
| " title=\"Combined blocks report\",\n", | ||
| " description=\"This report combines blocks from both Report 1 and Report 2\"\n", |
Collaborator
|
Can I merge this? |
Contributor
Need to fix missing commas, notebook doesn't run. |
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.
Fixes some typos in the previous version