[swift-corelibs-dev] Documentation and coding style

[Sergej Jaskiewicz]

Hello everyone.

I have a couple of questions about the core libraries that I think would be interesting to discuss.

The first question is about documentation comments. From what I can see in the repos and what the core team members say, those libraries lack them a lot. Maybe some of you have already asked this question, but can’t we just copy the Darwin Foundation & XCTest documentation comments? I can see it has been done in some parts of Swift Foundation, so why don’t we apply it to all the APIs? Of course taking into account the possible differences in behaviour or implementation.

The second question is about a coding style. It can be seen that in different parts of the Foundation/XCTest the coding style quite often differs. Maybe we could develop some kind of a document that would state the general rules.

Do you have any thoughts on this?

— Sergej