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

Minimally document externall debugging tools #77

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

Conversation

MariusDrulea
Copy link
Contributor

No description provided.

@MariusDrulea MariusDrulea changed the title fixed the additional args for sys images Document externall debugging tools Sep 4, 2023
@MariusDrulea MariusDrulea changed the title Document externall debugging tools Minimally document externall debugging tools Sep 4, 2023
@davidanthoff
Copy link
Member

I'm confused, why does this belong in the VS Code docs? Neither of this is a VS Code extension feature, and there doesn't seem to be anything VS Code specific in these docs? I wouldn't mind pointers to the two packages, but I don't think we should become a place for generic Julia programming advice.

@MariusDrulea
Copy link
Contributor Author

This is not advice for generic Julia programming. It's about providing users with a decent debugging experience. As I motivated here, all new users use the vscode extension and their first intro into debugging Julia is the julia-vscode documentation. Mentioning Debugger.jl and Infiltrator.jl in vscode docs is a must I think. It's much better than letting the user search the internet and the discourse forums to fix their debugging.
Now I agree with you extensive debugging examples shall be provided by these packages and I have removed the note that visual debugging examples will come in the vscode docs. Although Debugger.jl ships with the vscode extension so maybe...but let's have it like this for now.

@davidanthoff
Copy link
Member

So, I really think we should not start to add documentation about things that are unrelated to the VS Code extension to the docs for the VS Code extension. I am not saying that this kind of doc should not exist, but it should be somewhere else. We barely have the person power to keep docs that are focused on the extension up-to-date, if we start to add docs about other packages now that will just get worse.

Also, just for completeness: Debugger.jl does not ship with the extension. The visual UI in the extension and Debugger.jl use the same underlying debugging engine (JuliaInterpreter.jl), but beyond that they are just alternative UIs, one visual one text based.

I think a short sentence at the end of the docs saying "Here are some alternative debugging options" with links would be fine.

@MariusDrulea
Copy link
Contributor Author

MariusDrulea commented Sep 5, 2023

I think a short sentence at the end of the docs saying "Here are some alternative debugging options" with links would be fine.

I think this is way too minimalistic. I would add a brief description for them, just like the one for Infiltrator, plus pro and cons eventually. Remember vscode-docs is the first place all new users learn about debugging in Julia.
For the Debugger.jl pieces of code, let me try to add them to the Debugger.jl itself, once I have some more time.

Question:
So JuliaInterpreter is the one which ships with the extension. Is it possible to configure the Interpreter (the one used by the UI) with something like this?

union!(JuliaInterpreter.compiled_modules, setdiff(Base.loaded_modules_array(), Main))

@MariusDrulea
Copy link
Contributor Author

I have updated the section to only contain a brief description about each tool + links. I guess it's clear enough from the doc that these tools are not related to the vscode extension itself.

@MariusDrulea
Copy link
Contributor Author

@davidanthoff gentle reminder

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.

None yet

2 participants