Skip to content

Miscellaneous fixes, part 6 (plus an “IDE features” section) #23

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

savetheclocktower
Copy link
Collaborator

In one of my previous PRs I accidentally introduced a link to an “IDE features” section of the docs — something I've been meaning to write for a while, but hadn't gotten around to. Well, this is as good of an excuse as any, so here's that section in full.

It's not perfect, and it risks becoming an advertisement for my own packages. But I think it's quite helpful to new users and may even contain some information that's new to core team members. Where possible, I've illustrated these features with screenshots and/or screencasts.

Other than that, the changes are rather small — a broken link fixed, some style tweaks, et cetera.

* Don't put a border or background on `code` within a heading
* Scale videos to the content area automatically
* Left-align `figure` elements and make their captions italic
(TOCs will still hide themselves if there aren't enough headings to justify their presence.)
* In general, use fewer bare references to variables — `locals.foo` instead of merely `foo`, just in case something isn't defined
* Allow an API section title override to apply to the page title, too (if appropriate)
* Fail more gracefully if sidebar entries aren't present
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.

1 participant