Skip to content

librarian: decide and document whether API ordering can be considered important #4205

@jskeet

Description

@jskeet

Currently we sort the APIs by path, in tidy.formatConfig. Do we definitely want the ordering of APIs to have no meaning?

The Python generation code currently uses the first path in the list for the default version, and I'm adding the option for an override - but I'm now wondering whether if I should require an override if there's more than one API, so that I'm not relying on ordering at all.

Likewise repometadata.FromLibrary uses the service config associated with the first API in the library.

If we can't rely on the ordering being preserved, I think we ought to document that really carefully.

Alternatively, let's get rid of the code that performs the sorting, and document that it won't be changed by tidying/formatting.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions