[ECO-4915] (WIP) Add documentation comments #165
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mistake in 9c97883.
This is in preparation for implementing CHA-PR3h, in which a given numerical error code no longer necessarily implies a specific status code (specifically, RoomInInvalidState may now have a 400 or 500 status code depending on the context in which it is thrown). The internal API introduced here is a bit convoluted and verbose, but I’ve done it this way for two reasons: 1. It reflects the way the spec is written; most of the time a numeric code has a status code written alongside it 2. For the numerical error codes that _do_ always imply a certain status code, I want to be able to get that status code still, so that the existing Messages code that throws an error with the messagesAttachmentFailed code, as well as the isChatError(…) test helper, continue to work as they currently do.
Resolves #151.
I didn’t know the correct syntax ([1]). [1] https://www.swift.org/documentation/docc/linking-to-symbols-and-other-content#Navigate-to-a-Symbol
I’m going to introduce the DocC documentation compiler, which fails to resolve these links (there may well be a way to get it to do so, but I won’t be looking into that now).
Missed this in 1eb54c8.
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Using the SwiftPM DocC Plugin because [1] describes it as the “preferred option”. Part of #1. [1] https://www.swift.org/documentation/docc/documenting-a-swift-framework-or-package
lawrence-forooghian
force-pushed
the
1-add-documentation-comments
branch
from
47fe83c
to
3e09520
Compare
Taken from JS repo at 58a4fa2, only edited to match Swift documentation syntax.
Taken from JS repo at 58a4fa2, only edited to match Swift documentation syntax.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
Taken from JS repo at 58a4fa2, not edited at all.
lawrence-forooghian
force-pushed
the
CHA-PR3h-etc
branch
from
951e66b
to
cf769a1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: This PR is based on top of #163.
WIP for #1. What's here so far:
58a4fa2; the first few documentation comments are copied across with some light editing to match the Swift documentation syntax, but when it started to become clear that we were going to need deeper edits for a bunch of stuff I switched over to copying them over without any editing; we will have to do a second pass for editing. See commit messages for current progress.