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

Add print to .tex file example to examples.ipynb #199

Merged
merged 7 commits into from
Dec 7, 2023
Merged

Conversation

ctarnold
Copy link
Contributor

@ctarnold ctarnold commented Dec 5, 2023

Overview

Adding the functionality of printing to a .tex file to the examples.ipynb file.

Details

Adds a new block to the python notebook duplicating the solve function into solve1. The code opens a new file, latexifyExample.tex, and prints the solve function in latex syntax to this file.

References

Issue #198

Blocked by

None

Duplicating last block to then add a new example
Adding example of printing to a .tex file in solve1, the duplicated solve function.
Changing output data in notebook under solve1 to explain to user the functionality of printing to the .tex file
@ctarnold ctarnold requested a review from odashi as a code owner December 5, 2023 17:48
Copy link

google-cla bot commented Dec 5, 2023

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@odashi
Copy link
Collaborator

odashi commented Dec 5, 2023

Hi @ctarnold , thank for proposing the change! Could you see my comments on #198 (comment) ?

Modifying print example to align with common python practice by @odashi 's recommendation.
Fixing typo in JSON file representation of examples.ipynb
Previous JSON file worked, fixing display of the code by removing \t from the added printing example.
Comment on lines 182 to 184
"text/plain": [
"The above equation is sent to a new file, latexifyExample.tex"
]
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks this is not a real output. I think it is better to put this paragraph as a comment of the code block.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. Perhaps rather than relocate this, removal may be sufficient if the current comment at the top of the block is descriptive enough.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah let's remove it as you said.

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 removed that plain text you highlighted in the recent commit. Let me know how it looks.

Removing plain text from output field in JSON description of the .tex output example.
Copy link
Collaborator

@odashi odashi left a comment

Choose a reason for hiding this comment

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

Cool, thanks! After merging this change I will tweak the presentation a bit.

@odashi odashi merged commit 3c31818 into google:main Dec 7, 2023
10 checks passed
@ctarnold
Copy link
Contributor Author

ctarnold commented Dec 7, 2023

Thanks @odashi! Pleasure working with you through this.

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.

2 participants