Skip to content

gh-94635: Normalise sqlite3 doc headings #94677

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

Closed

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jul 7, 2022

Fixes #94635

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Per the devguide,

    In the Python documentation, the use of sentence case in section titles is preferable, but consistency within a unit is more important than following this rule. If you add a section to a chapter where most sections are in title case, you can either convert all titles to sentence case or use the dominant style in the new section title.

    Since around half or more of the tiles are already sentence case, if we're going to change it, it makes sense to do so to the preferred style.

  • I'm not sure adding the "How to" prefix is necessary on titles that already are framed as tasks, since it is somewhat redundant and repetitive, especially if/when the supersection title is changed to "How-to"—it is inherent than sections directly underneath a "How to" section describe "How to" do something.

  • While you're at it and touching these anyway, you could normalize it to use the standard heading levels in the devguide—basically, just moving everything up a level, IIUC. But that's strictly optional, of course.

Other than that, this seems okay, assuming the plan is to move "Default Adapters and Converters" and "Adapter and Converter Recipes", etc., under their appropriate "How-to" sections ("Adapt..." and "Convert...") in the followup PR.

Thanks!

@erlend-aasland erlend-aasland marked this pull request as draft July 14, 2022 22:25
@erlend-aasland
Copy link
Contributor Author

While you're at it and touching these anyway, you could normalize it to use the standard heading levels in the devguide—basically, just moving everything up a level, IIUC. But that's strictly optional, of course.

I'm planning to address that in a separate PR. Let's do the headings first; I want these doc PRs to be concise.

@erlend-aasland
Copy link
Contributor Author

I'm not sure adding the "How to" prefix is necessary on titles that already are framed as tasks, since it is somewhat redundant and repetitive, especially if/when the supersection title is changed to "How-to"—it is inherent than sections directly underneath a "How to" section describe "How to" do something.

Absolutely, but Diátaxis explicitly recommends such headings: https://diataxis.fr/how-to-guides/#pay-attention-to-naming

@erlend-aasland erlend-aasland marked this pull request as ready for review July 20, 2022 22:21
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jul 21, 2022

Regarding the "How to" prefix; perhaps we should put this PR on hold until we're through the Diátaxis workshop in August. There is no hurry to get this done anyways.

@erlend-aasland erlend-aasland marked this pull request as draft July 21, 2022 19:25
@CAM-Gerlach
Copy link
Member

Absolutely, but Diátaxis explicitly recommends such headings: diataxis.fr/how-to-guides/#pay-attention-to-naming

Right, but that's for top-level page titles, and the section headings would still be worded in task-oriented "how to" form (e.g. "(How to) adapt Python types to custom SQLite values", rather than the proscribed "Adapting Python types to custom SQLite values" or "Python-SQLite type conversion", with the "How to" wording as the top-level parent section, just not also repeated again in every sub-section title underneath it.

@erlend-aasland
Copy link
Contributor Author

I guess you're right; that makes sense. I'd still like to put this on hold until after the workshop.

@erlend-aasland
Copy link
Contributor Author

Here's how Django has organised their How To chapter:

https://docs.djangoproject.com/en/4.0/howto/

@erlend-aasland
Copy link
Contributor Author

Closing this, as most of the work has been done in other PR's. If we need to tweak headings, we can do so on a case-by-case basis.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting merge DO-NOT-MERGE docs Documentation in the Doc dir needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructure the sqlite3 docs table-of-contents
4 participants