You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Surge functionality is, for the most part, "self-documenting". Functions follow standard naming conventions and take typed LHS / RHS arguments in such a way that anyone familiar with the domain shouldn't have much trouble understanding how anything works.
However, providing documentation comments would add support for Xcode help and allow tools like swift-doc to generate a formal API reference. The current approach of organizing functions under MARK headers provides some benefit, but having proper documentation comments would be an improvement.
The text was updated successfully, but these errors were encountered:
Surge functionality is, for the most part, "self-documenting". Functions follow standard naming conventions and take typed LHS / RHS arguments in such a way that anyone familiar with the domain shouldn't have much trouble understanding how anything works.
However, providing documentation comments would add support for Xcode help and allow tools like swift-doc to generate a formal API reference. The current approach of organizing functions under
MARK
headers provides some benefit, but having proper documentation comments would be an improvement.The text was updated successfully, but these errors were encountered: