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

Improve information collected by the Python: Report Issue command #19067

Closed
karrtikr opened this issue May 4, 2022 · 2 comments · Fixed by #19068 or #19095
Closed

Improve information collected by the Python: Report Issue command #19067

karrtikr opened this issue May 4, 2022 · 2 comments · Fixed by #19068 or #19095
Assignees
Labels
area-editor-* User-facing catch-all feature-request Request for new features or functionality verification-needed Verification of issue is requested verified Verification succeeded
Milestone

Comments

@karrtikr
Copy link

karrtikr commented May 4, 2022

  • Template should only carry a setting if it's explicitly set.

For eg. if python.venvFolders is not set or set to its default value, do not have the following information in the report as it does not tell anything:

venvFolders: "<placeholder>"
  • Carry whether it's a multiroot workspace.

Note currently we only display setting values for the first workspace folder, which may not always apply to other folders. If it's a multiroot workspace, we may need to ask users for any additional settings.

cc/ @paulacamargo25

  • Remove defaultLS internal setting and non-existent settings

The is set on the basis of whether Pylance is installed. If Pylance is explicitly selected but not installed, this is something we should know about, but it's a rare case. So we can rely on logs for this instead of having this in every bug report.

  • Include Python Output channel logs in issue template

We need it most of the times, not sure why it was removed.

@karrtikr karrtikr added feature-request Request for new features or functionality needs PR area-editor-* User-facing catch-all labels May 4, 2022
@karrtikr karrtikr self-assigned this May 5, 2022
@karrtikr karrtikr added this to the May 2022 milestone May 5, 2022
@karrtikr karrtikr added the verification-needed Verification of issue is requested label May 5, 2022
@karrtikr karrtikr changed the title Improve information collected by the Report Issue command Improve information collected by the Python: Report Issue command May 5, 2022
@joyceerhl joyceerhl added the verified Verification succeeded label Jun 1, 2022
@joyceerhl
Copy link

I set venvFolders in my user settings to a bogus string array value and got venvFolders: "<placeholder>" in the report issue output. Is that intentional e.g. for PII redacting purposes, or should it be the actual value?

@karrtikr
Copy link
Author

karrtikr commented Jun 1, 2022

Yep that's intentional, and for PII. The thing to verify is that it should only contain the settings which are explicitly set, earlier it used to carry all the settings.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-editor-* User-facing catch-all feature-request Request for new features or functionality verification-needed Verification of issue is requested verified Verification succeeded
Projects
None yet
2 participants