8000 Luminescent docs by paulxshen · Pull Request #585 · gdsfactory/gplugins · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Luminescent docs #585

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
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Luminescent docs #585

wants to merge 9 commits into from

Conversation

paulxshen
Copy link
Contributor
@paulxshen paulxshen commented May 16, 2025 •
edited by sourcery-ai bot
Loading

I moved docs to Luminescent gh readme so was wondering if can just relink there

Summary by Sourcery

Streamline the luminescent.ipynb notebook by removing inline documentation and tutorials, and direct users to the repository’s main README for documentation

Enhancements:

  • Update notebook metadata (nbformat and kernel spec) for Colab compatibility

Documentation:

  • Replace the detailed luminescent.ipynb content with a simple link to the central GitHub README

@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented May 16, 2025 •
edited
Loading

Reviewer's Guide

This PR replaces the comprehensive local luminescent.ipynb documentation with a minimal notebook that simply links to the central GitHub README, and adjusts notebook metadata accordingly.

File-Level Changes

Change Details Files
Relink local notebook to central repository docs and remove embedded content
  • Deleted all existing markdown and code cells containing tutorials, features, and links
  • Added a single markdown cell pointing to the GitHub repository URL
  • Retained an empty code cell as a placeholder
  • Updated notebook metadata (nbformat_minor, kernelspec, language_info, and added colab section)
 notebooks/luminescent.ipynb
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed May 16, 2025
View reviewed changes
Copy link
Contributor
@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @paulxshen - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

At least 1 approving review is required to merge this pull request.

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

Successfully merging this pull request may close these issues.
1 participant
@paulxshen
0