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

Describe how new Code Style and Docstring Style options work in Spyder 4 #96

Open
CAM-Gerlach opened this issue May 4, 2019 · 4 comments

Comments

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented May 4, 2019

Issue Description

Per the discussion in spyder-ide/spyder#9231 and specifically @ccordoba12 's request, we should describe how to use the Code and Doc Style settings in Spyder 4's preferences, particularly the interaction between the "Show" and "Ignore" fields. This would probably be best worked into an expanded Editor article, specifically a discussion on the various LSP-provided features the editor offers (Code Analysis, Hints, Calltips, Completion, etc.); otherwise; it would be part of a broader article/docs section that discusses Spyder's preferences in more detail (which I hope to add at some point).

@CAM-Gerlach CAM-Gerlach added this to the v4.0 milestone May 4, 2019
@CAM-Gerlach CAM-Gerlach changed the title Describe how Code Style and Docstring Style options work Describe how new Code Style and Docstring Style options work in Spyder 4 May 4, 2019
@ccordoba12 ccordoba12 removed this from the v4.0 milestone Mar 15, 2020
@juanis2112
Copy link
Contributor

Adding this as editor feature

@juanis2112 juanis2112 self-assigned this Jun 23, 2020
@CAM-Gerlach
Copy link
Member Author

@hyounes4560 if you have time, we could work this in to an expanded discussion of the Code/docstring style options in the "Code Style" section of the Editor doc, though I don't think we should block your initial PR on this—it can be added later, and I can take care of it if necessary, since its a more advanced feature.

@hyounes4560
Copy link
Contributor

@CAM-Gerlach Could you please add more info about this?

@CAM-Gerlach
Copy link
Member Author

Sure. Basically, we want to describe how the Show and Ignore fields work in the Code Style and Docstyle tabs under the Completion and Linting Preferences pane, i.e. as Daniel describes in his comment I linked above: spyder-ide/spyder#9231 (comment) However, upon closer inspection, this is fairly minor and can be added later, either by you, me or somewhere else, since it is a pretty advanced feature. So, I wouldn't worry about this for #331 unless you really want to, in which case I'm happy to help guide you further.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants