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

Integration with Jupyter extension #46

Open
JeremyMullins opened this issue Nov 27, 2023 · 2 comments
Open

Integration with Jupyter extension #46

JeremyMullins opened this issue Nov 27, 2023 · 2 comments

Comments

@JeremyMullins
Copy link

First of all, thank you for such a smart, intelligently designed extension!

I just wanted to ask for some clarification on whether this is an actual issue/bug or just me completely not understanding the use-case/limitations of this extension.

I use Jupyter extensively for the work that I do. It's a fantastic way for me to test out Python code in small individual cells. I do need to keep a ton of notes and that usually means lots and lots of comments that I have to keep track of.

So I install the extension, and everything works just fine in terms of adding the annotation, but I immediately run into a few snags:

  • There's no indication on the line that an annotation has been placed.
  • When I go to the Code Annotation Pane, the annotation exists and everything looks correct except for when I click on the note, it doesn't take me to the location in the script where I placed the annotation; it places me at the top of the script (which I'm guessing isn't the intended outcome of that action).

I've created a test notebook (notebook extensions are .ipynb) and have screenshots below showing what I'm talking about above (I apologize if I'm not the best with explaining things).

This image gives you an idea of what my workspace looks like when I write code:

image

I've put an annotation on the mkdir(outputfolder) line saying "Make folder if it doesn't exist. As you can see, it doesn't show any highlighting or notification that an annotation exists at that line:

image

As you can see it shows up perfectly fine in the Code Annotation pane:

image

But when I click on the annotation to take me to the location in the script where I placed it, it only takes me to the top of the script (it's hard to see but the cursor is on line 3 of the image below):

image

Now I'm guessing it has something to do with the fact that .ipynb filetypes aren't simply plain text files containing raw code and that this information is stored in what looks to be a fancy JSON, but I'm new to all of this so that's a guess.

Is there a chance that there will be support for Jupyter filetypes?

Thanks again and apologies for the long message.

@thamara
Copy link
Owner

thamara commented Dec 27, 2023

Hi @JeremyMullins, thanks for reporting this, and for including screenshots and very good descriptions! This helps a lot!
The usage os Jupyter is not something I have factored in when developing this extension, but it does sounds like a very nice feature.
I agree with you that it probably has something to do with the fact that .ipynb are not plain text files, but I think there should be a way to add/improve the support for these files.
I'm going to do some tests here and will update this issue when I have something.

@thamara
Copy link
Owner

thamara commented Jan 2, 2024

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

No branches or pull requests

2 participants