Skip to content

[docs] merge error code lists #20077

Open

Description

@wyattscarpenter

Documentation

error_code_list.rst and error_code_list2.rst should be merged. The main result of having two pages is that half the time I end up checking the wrong page if I don't know beforehand whether the code is enabled or disabled by default. Instead, that enablement information should be documented in each entry (possibly also whether or not it's enabled by default in strict mode, ideally).

To elaborate a little, perhaps unnecessarily, I assume there are three types of interactions we could be designing the error codes page(s) for:

  1. People reading the documentation cover-to-cover, or similar. Having the error codes split up like this is probably useful to them, but I doubt this is a common interaction.
  2. People searching for the error codes using a search engine. These people probably get to the right page either way. While this is useful, usually I don't do this and I try to go directly to the error page, because a general search will sometimes give you unhelpful pages that just happened to mention the code
  3. People already on the page, using ctrl-f to cross-reference or find entries. I think this is a useful activity and it's greatly stymied by having them split apart on different pages.

While we're at it, the current error_codes.rst could just be a preamble, and all three pages could be merged into one.

Ideally, preservative redirects would be made. As in any documentation refactor.

Activity

  1. kekedy0212-design commented on Dec 8, 2025

    @kekedy0212-design

    We are a group of students and would like to work on this documentation merge task. We'll submit a PR soon.

  2. wyattscarpenter commented on Dec 8, 2025

    @wyattscarpenter
    ContributorAuthor

    Thanks! Let me know how the redirects go, if you figure that part out. I'm not really sure how you're actually supposed to do that in Sphinx, if it's even possible.

    To everyone else, especially the maintainers who will eventually accept or reject a PR enacting this issue: I'd be curious if anyone opposes or supports this change.

  3. dhanusharer commented on Mar 4, 2026

    @dhanusharer

    Hi, I noticed there was a previous PR related to merging the error code documentation pages. Is this issue still open for contributions? I would be happy to work on it if it hasn't been resolved yet.

  4. wyattscarpenter commented on Mar 4, 2026

    @wyattscarpenter
    ContributorAuthor

    It's still open for contributions. See if you can figure out redirects in Sphinx along the way.

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions