Browse Source

Add labeled method to docs (#485)

The labeled feature is amazing for debugging, but is not obviously documented.
Tyler Alves 7 years ago
parent
commit
5a012e926a
1 changed files with 19 additions and 1 deletions
  1. 19 1
      docs.md

+ 19 - 1
docs.md

@@ -180,7 +180,7 @@ make.left.equalTo(view).offset(UIEdgeInsets(top: 10, left: 0, bottom: 10, right:
 
 > `.priority` allows you to specify an exact priority
 
-Priorities are can be tacked on to the end of a constraint chain like so:
+Priorities can be tacked on to the end of a constraint chain like so:
 
 ```swift
 make.top.equalTo(label.snp.top).priority(600)
@@ -354,6 +354,24 @@ class MyViewController: UIVewController {
 }
 ```
 
+### Debug with ease
+> `.labeled` allows you to specify constraint labels for debug logs
+
+Labels can be tacked on to the end of a constraint chain like so:
+
+```swift
+button.snp.makeConstraints { (make) -> Void in
+  make.top.equalTo(otherView).labeled("buttonViewTopConstraint")
+}
+```
+
+Resulting `Unable to simultaneously satisfy constraints.` logs will use constraint labels to clearly identify which constraints need attention:
+
+```
+"<SnapKit.LayoutConstraint:buttonViewTopConstraint@SignUpViewController.swift#311
+UIView:0x7fd98491e4c0.leading == UIView:0x7fd983633880.leading>"
+```
+
 <br/>
 <br/>
 <br/>