What is the appropriate process for updating documentation for public API?

Development Standard Library
,
1

what is the generally recommended/desired process for updating documentation within the core libraries (for the sake of example, assume we're talking about the stdlib)? if i find something that seems inaccurate/misleading, should i:

  1. open a PR with my personal proposed changes?
    a. do this, and add particular individuals as reviewers?
  2. file a feedback with Apple?
  3. something else?

and somewhat relatedly, are there any technical writers/editors that are involved in this process?

2

Any of these are generally fine. If it's just a typo or minor correction, opening a PR is probably best. If it's more of a broad conceptual change, opening a GitHub issue (or posting here on the forums) to discuss it first would be a good option.

Tagging code owners (e.g. standard librarians for stdlib changes) is always appropriate.

2 Likes