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

Update paragraph on changing format in array editor for Spyder 6 #342

Open
2 of 8 tasks
jitseniesen opened this issue Feb 5, 2023 · 1 comment · May be fixed by #345
Open
2 of 8 tasks

Update paragraph on changing format in array editor for Spyder 6 #342

jitseniesen opened this issue Feb 5, 2023 · 1 comment · May be fixed by #345
Assignees
Labels
6.x Issues specific to the 6.x branch type:Spyder Change

Comments

@jitseniesen
Copy link
Member

Issue Report

Issue Description

Now that spyder-ide/spyder#20473 is merged, the documentation of the variable explorer needs to be updated to reflect this.

Where is the relevant portion of the documentation located?

https://docs.spyder-ide.org/current/panes/variableexplorer.html#numpy-arrays end of paragraph 2.

What would you suggest it be replaced with?

We can just replace "printf-style syntax" with "format specification" (or whatever the correct term is) and change the link.

Other information

  • Is the problem specific to documentation for a particular version of Spyder?

    • N/A
    • Spyder 5 (master)
    • Spyder 4 (4.x)
    • Spyder 3 (3.x, frozen)
    • Spyder 6 (I added this option!)
  • Are you planning on submitting a Github pull request with a suitable change?

    • Yes (assuming a suitable branch is created or I'm told otherwise)
    • No
    • Maybe so
  • NB 1: There does not seem to be a branch for Spyder 6 documentation.

  • NB 2: I believe it is best to update the documentation simultaneous with the code now that we have a decent amount of documentation to build on. Perhaps something to be discussed.

@CAM-Gerlach CAM-Gerlach added this to the spyder-6 milestone Feb 5, 2023
@CAM-Gerlach CAM-Gerlach removed this from the spyder-6 milestone Feb 5, 2023
@CAM-Gerlach CAM-Gerlach added the 6.x Issues specific to the 6.x branch label Feb 5, 2023
@CAM-Gerlach
Copy link
Member

Thanks for the detailed report, @jitseniesen . Since we're close to the more or less final planned non-maintenance mode changes to the 5.x branch and move toward targeting all non-critical work toward the 6.x branch, I was planning on just waiting until that point to formally branch 5.x, since maintaining another branch makes merging more complicated and every build take longer. However, this issue serves to document the change, and you could open a PR against master which could then be merged once 5.x is branched.

@jitseniesen jitseniesen linked a pull request Feb 6, 2023 that will close this issue
5 tasks
@CAM-Gerlach CAM-Gerlach changed the title Update paragraph on changing format in array editor for v6 Update paragraph on changing format in array editor for Spyder 6 Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.x Issues specific to the 6.x branch type:Spyder Change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants