search

spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment
https://docs.spyder-ide.org
MIT License
33 stars 283 forks source link

PR: Add explanation on the use of subsections in the Outline Explorer #293

Closed ghost closed 2 years ago

ghost commented 2 years ago

Pull Request

Pull Request Checklist

Description of Changes

I added a paragraph on the use of subsections in the Editor to create a multi-level outline view in the Outline Explorer.

This is a retry of pull request #285, using the correct branch and upstream version, thanks for the guiding comments.

Issue(s) Resolved

Fixes #40

CAM-Gerlach commented 2 years ago

Hey @ba-tno , thanks for the super quick reply! It looks like only the first suggestion got applied and others two were not; was that what you intended?

ghost commented 2 years ago

No, I thought I added three suggestions to the batch and committed that batch.... Let me try that again.

ghost commented 2 years ago

I've now applied the suggestion in separate commits, I hope this works now.

CAM-Gerlach commented 2 years ago

Thanks, sorry for that! Looks like everything is applied now, so its good to go from my end. Once the checks pass I'll approve, mark this as draft to remind us to fix the commits before merging, and tag another reviewer for a final look.

CAM-Gerlach commented 2 years ago

BTW, this fixes issue #40 ; didn't notice that before sorry.

CAM-Gerlach commented 2 years ago

Rebased to drop the wonky prior commits, optimize the image and fixup the review commits, and everything's merged now and the changes are live. Thanks again for your work and bearing with us, @ba-tno .

It is also worth to have this in Spyder 5.x. What do you think is the best way of doing this @CAM-Gerlach?

@juanis2112 Same as in the main Spyder repo, after a PR is merged 4.x gets merged to master, so always it picks up any changes in 4.x (aside from merge conflicts and version-specific differences, which get manually resolved). This is why the message just above this comment appears (you might remember it from Spyder's repo too). In fact, it is this merge to master that triggers a rebuild of the site, as due to the architecture of sphinx-multiversion, all branches are built off the config in master.

Somewhat off topic, but it might be a good idea for us to have a maintainer guide where this information is documented. That would also be an appropriate place to document PR review level standards, build system information, the translation procedure, the release cycle/process, pre-commit and other such things that aren't really relevant to the average contributor but are important to know for maintainers. That way, if something happens to me again (or same to you), there would be a record of all this and clear step by step instructions that a new maintainer could follow (plus its helpful for us if we ourselves forget).