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

fix(colabs): Update docs for Report API #357

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

andrewtruong
Copy link

Fixes some typos in the previous version

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions
Copy link

The following colabs where changed
-colabs/intro/Report_API_Quickstart.ipynb

Copy link
Contributor

@ngrayluna ngrayluna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing comma

"report = wr.Report(\n",
" PROJECT,\n",
" title='W&B Block Gallery',\n",
" description=\"Check out all of the blocks available in W&B\"\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing comma

"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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing comma

"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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing comma

"report3 = wr.Report(\n",
" PROJECT,\n",
" title=\"Combined blocks report\",\n",
" description=\"This report combines blocks from both Report 1 and Report 2\"\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing comma

@tcapelle
Copy link
Collaborator

Can I merge this?

@ngrayluna
Copy link
Contributor

Can I merge this?

Need to fix missing commas, notebook doesn't run.

@tcapelle tcapelle marked this pull request as draft March 8, 2023 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants