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.

Sign up for GitHub

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

Jump to bottom

Portfolio Docs #3395

Merged
merged 3 commits into from
Jul 24, 2024
Merged

Portfolio Docs #3395

merged 3 commits into from
Jul 24, 2024

Conversation

amandaha8
Copy link
Contributor

@amandaha8 amandaha8 commented Jul 11, 2024 •
edited
Loading

Description

As part of our Summer Refactor 2024 efforts, I have been updating our docs page.

  1. Updated the static documents section with code that demonstrates how to convert a notebook to a PDF, link to a script that parameterizes a notebook and then turns everything to a PDF, and tips and tricks.
  2. Updated the the portfolio section to state that the %%capture_parameter cell cannot contain even commented out code.
  3. More copyediting. Deleted extra semicolons off of headers. Made sure sample code blocks are denoted correctly.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

@amandaha8 amandaha8 requested a review from tiffanychu90 as a code owner July 11, 2024 21:27
@github-actions GitHub Actions
Copy link

Preview url: https://docs-data-infra-3395--cal-itp-previews.netlify.app

@amandaha8
Copy link
Contributor Author

@csuyat-dot Can you check this page for any typos, any additional suggestions, and if I wrote down your code on how to convert notebooks to PDF right? Thanks!

@amandaha8 amandaha8 requested a review from edasmalchi July 22, 2024 18:26
edasmalchi
edasmalchi reviewed Jul 22, 2024
View reviewed changes
Copy link
Member

@edasmalchi edasmalchi left a comment

Choose a reason for hiding this comment

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

looks good overall, just one comment on using %%capture_parameters

docs/publishing/sections/4_notebooks_styling.md Outdated
%%capture_parameters
district
```
- Your code cell must <b>exactly</b> like this or else your notebook won't parameterize.
Copy link
Member

Choose a reason for hiding this comment

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

afaik it is technically possible to have more code/comments in one of these cells, just as long as %%capture_parameters remains at the very top of the cell. For example speedmaps has 2 of these, with an extra line of code: https://github.com/cal-itp/data-analyses/blob/main/ca_transit_speed_maps/speedmaps.ipynb

Perhaps we should rephrase this to a recommendation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes I'll rephrase this. Thanks for checking this out

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just updated it! Could you check it out again? Thanks. @edasmalchi

edasmalchi
edasmalchi approved these changes Jul 24, 2024
View reviewed changes
Copy link
Member

@edasmalchi edasmalchi left a comment

Choose a reason for hiding this comment

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

looks good, thanks!

@amandaha8 amandaha8 merged commit 81dc274 into main Jul 24, 2024
2 checks passed
@amandaha8 amandaha8 deleted the ah_docs branch July 24, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edasmalchi edasmalchi edasmalchi approved these changes

@tiffanychu90 tiffanychu90 Awaiting requested review from tiffanychu90 tiffanychu90 is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@amandaha8 @edasmalchi