swift

organizes new articles into the existing pages for descriptions and groups

#82350

Closed

Ah... I really need to add that check I said I'd add in 😬 Thanks for adding these. I know you didn't add it, but would you like to summarize the initial paragraph in missing-module-on-known-paths? It's a bit long for the one-liner IMO.

EDIT: Also, mind making the additions alphabetical?

I don't have a sense for the size this will grow to, but if the list gets notably longer, it would make a lot of sense to start looking for ways to group these rather than utilizing alphabetical organization. And even that's tricky, as not all the markdown file names align to the titles in those articles. Changing the markdown file name will change the the URL that the page is pinned out, so if you're referencing these externally - I'd recommend being quite strict about those changes, and maybe building up a convention of always naming the markdown file after the name of the Group or Diagnostic.

I'd be happy to retrofit the markdown file name in a separate PR if you'd like to go that route.

I'm not sure there really is another great way to group these (outside of the existing grouping I added).

and maybe building up a convention of always naming the markdown file after the name of the Group or Diagnostic

I can add a check for this when I add one for the docs themselves. @DougGregor / @hborla any opinions here? Seems reasonable to expect the title + filename to match. Now is probably the best time to fix that up if we do want it.

I don't have a sense for the size this will grow to, but if the list gets notably longer, it would make a lot of sense to start looking for ways to group these rather than utilizing alphabetical organization.

As an eventual upper bound, every single warning diagnostic (and probably some error diagnostics) could have its own group (though practically speaking, many groups will cover more than one diagnostic). I just grepped main and count 372 warnings (and 10 times as many errors).

This is a diagnostic group isn't it (CC @artemcm)?

EDIT: Yep -

include/swift/AST/DiagnosticGroups.def
52:GROUP(ImplementationOnlyDeprecated, "implementation-only-deprecated")

Whoops, this was meant to be a @tshortli ping (Artem was one of the ones below)