Conversation
| * ``AbstractBuilder`` has the following generic parameters: | ||
| * | Name | Description | | ||
| * | ------------------------------ | ------------------------------------------------------------------------------ | | ||
| * | ComponentType | The DI graph `Component` type. | | ||
| * | BuildType | The type of `Flow` object the ``AbstractBuilder`` instance will create. | | ||
| * | DynamicBuildDependencyType | The type of dependency provided dynamically to the `BuildType` instance. | | ||
| * | DynamicComponentDependencyType | The type of dependency provided dynamically to the `ComponentType` instance. | |
There was a problem hiding this comment.
I dont think we need to add spaces to the end up the table.
There was a problem hiding this comment.
Those were added so the | symbols align vertically.
There was a problem hiding this comment.
I dont think we need to add spaces for this table though. The table should extend to the end of the longest line plus one space and one vertical bar. The longest line is line 19 which appears to have an extra space.
There was a problem hiding this comment.
Oh, if that is the case, I can adjust 👍
| /// | ||
| /// The closure has the following arguments: | ||
| /// | Name | Description | | ||
| /// | Name | Description g | |
There was a problem hiding this comment.
Good catch 👍
Sources/Nodes/ViewControllable/UIKit/NavigationControllable/NavigationControllable.swift
Show resolved
Hide resolved
Sources/Nodes/ViewControllable/UIKit/TabBarControllable/TabBarControllable.swift
Show resolved
Hide resolved
| To avoid bloating the `Context` instance, data transformations and other business logic can exist in the Node's `Worker` instances, and the `Context` may call methods on those `Worker` instances as needed. | ||
|
|
||
| The `Context` may participate in keeping the Node's user interface (through a `Presentable` protocol) in sync with the current app state, though the view state dedicated `Worker` provided to the Node normally handles this responsibility. | ||
| The `Context` may participate in keeping the Node's user interface (through a `Presentable` protocol) in sync with the current app state, though the Node's view state dedicated `Worker` normally handles this responsibility. |
There was a problem hiding this comment.
Maybe this reads better?
...though the Nodes' dedicated view state `Worker`
There was a problem hiding this comment.
How about simply this?
... though the Node's view state `Worker` ...
There was a problem hiding this comment.
Sounds good :)
| /// - completion: An optional closure to execute when the dismissal is finished. | ||
| /// | ||
| /// The closure has no arguments and returns `Void`. | ||
| /// The closure has no arguments and returns ``Void``. |
There was a problem hiding this comment.
What does "Void" link to? Swift.Void? If so, I wonder why we dont need to link to it directly whereas with UIKit types, we do.
There was a problem hiding this comment.
It does not link to anything.
There was a problem hiding this comment.
Why are we using double slashes then?
There was a problem hiding this comment.
So they would link to something (meaning link to the doc page for Void).
There was a problem hiding this comment.
Since they are not, we can remove them. But maybe good to leave them on the chance that a future version of DocC will link them properly.
There was a problem hiding this comment.
I guess that I what I was getting at then. Why do we explicitly link to some things and then implicitly link to others. What is the style guide rule to follow here?
There was a problem hiding this comment.
I would prefer that DocC just link them.
There was a problem hiding this comment.
I changed back to single backticks.
2 participants
No description provided.