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

Renaming jupyter notebook functions #7391

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

soheegoo
Copy link

@soheegoo soheegoo commented Jan 25, 2025

Proposed Changes

(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)

Refactored function and file names used for displaying the HTML content of Jupyter Notebook submission files. Previously, the naming was specific to notebooks, but now it is generalized to reflect that these functions/files are used to display previews of HTML content for any files converted to HTML. This change expands the scope of these functions to also support HTML previews of RMarkdown files (PR #7390).

...

Screenshots of your changes (if applicable)
Associated documentation repository pull request (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality) X
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@soheegoo soheegoo marked this pull request as ready for review January 25, 2025 02:55
@coveralls
Copy link
Collaborator

coveralls commented Jan 25, 2025

Pull Request Test Coverage Report for Build 12981929356

Details

  • 32 of 34 (94.12%) changed or added relevant lines in 7 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 91.87%

Changes Missing Coverage Covered Lines Changed/Added Lines %
app/javascript/Components/Result/file_viewer.jsx 0 1 0.0%
app/javascript/Components/Result/html_viewer.jsx 0 1 0.0%
Totals Coverage Status
Change from base Build 12966565418: 0.0%
Covered Lines: 41290
Relevant Lines: 44262

💛 - Coveralls

Copy link
Collaborator

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

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

@soheegoo this looks great, thanks! I just left two minor comments

Changelog.md Show resolved Hide resolved
app/assets/javascripts/Annotations/html_annotations.js Outdated Show resolved Hide resolved
@soheegoo soheegoo requested a review from david-yz-liu January 27, 2025 04:15
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