search

ScottRobbins / DeclarativeLayout

A declarative, expressive and efficient way to lay out your views.
MIT License
5 stars 0 forks source link

README should specify all constraints passed to activate should be unactivated #10

Closed ScottRobbins closed 5 years ago

ScottRobbins commented 6 years ago

The framework expects all constraints passed to "activate" to be unactivated. The README should point this out, as many autolayout DSLs by default will activate constraints.

ScottRobbins commented 5 years ago

I should also consider adding an assert or a log when people pass in activated constraints explaining it's a bad idea.

ScottRobbins commented 5 years ago

Since this issue is about updating documentation, there should be a shorter examples in the README. Also consider removing blank lines if that makes it easier to read. I think how much is in the examples distracts from the summary of why you'd lose the library. There are full examples in the repo to give a more complete view of how the library would be used.

ScottRobbins commented 5 years ago

Should also better emphasize the declarative part of the library. Right now it's in. text but it should probably be highlighted by a bolder title or something like that.

ScottRobbins commented 5 years ago

I think i should change the quickstart VC to be simple but display the declarative layout better. Maybe rename it from quickstart VC. Really the registration examples are the best place to see how to use the framework.

ScottRobbins commented 5 years ago

should add links to section of readme at top

ScottRobbins commented 5 years ago

I should also consider adding an assert or a log when people pass in activated constraints explaining it's a bad idea.

I'm not going to do this since I can't rely on #if DEBUG directives, and it would probably affect performance to check that property on every constraint passed in.

ScottRobbins commented 5 years ago

done