Touch up docs

This commit is contained in:
Chris Eppstein 2010-11-15 17:41:03 -08:00
parent b49f2c7b0b
commit 5f11b126e6
2 changed files with 20 additions and 14 deletions

View File

@ -35,23 +35,23 @@ what changed to your stylesheets:
10. Scroll or use your arrow keys to review the differences between the files. 10. Scroll or use your arrow keys to review the differences between the files.
11. If you're satisfied: $ git commit -a -m "Upgraded compass" 11. If you're satisfied: $ git commit -a -m "Upgraded compass"
12. If you're scared again: 12. If you're scared again:
A. Don't panic. 1. Don't panic.
B. Read the [CHANGELOG](http://compass-style.org/docs/CHANGELOG/) and 2. Read the [CHANGELOG](http://compass-style.org/docs/CHANGELOG/) and
see if the changes are explained there. see if the changes are explained there.
B. Send an email to the [mailing list](http://groups.google.com/group/compass-users) 3. Send an email to the [mailing list](http://groups.google.com/group/compass-users)
explaining the problem and providing enough context like snippets from your diff explaining the problem and providing enough context like snippets from your diff
and the relevant snippets of your sass/scss files. In rare cases we might request and the relevant snippets of your sass/scss files. In rare cases we might request
that you construct a simple compass project that exhibits the issue and make an that you construct a simple compass project that exhibits the issue and make an
archive of it and send us an email with it attached. archive of it and send us an email with it attached.
C. If it's pretty obviously a bug. Please file an issue 4. If it's pretty obviously a bug. Please file an issue
on [github](http://github.com/chriseppstein/compass/issues). If you're experiencing on [github](http://github.com/chriseppstein/compass/issues). If you're experiencing
a crash, please run the command with the --trace option and record the output for a crash, please run the command with the --trace option and record the output for
diagnostic purposes. diagnostic purposes.
D. $ sudo gem uninstall compass 5. $ sudo gem uninstall compass
Select the newest version of compass. You have now downgraded to the old Select the newest version of compass. You have now downgraded to the old
version of compass. version of compass.
E. $ compass compile --force 6. $ compass compile --force
F. Diff the folders as in steps 7 through 9. 7. Diff the folders as in steps 7 through 9.
13. Breathe a sigh of relief. 13. Breathe a sigh of relief.

View File

@ -152,8 +152,9 @@ $default-skew-y : 5deg !default;
@include transform($trans, true); @include transform($trans, true);
} }
// @doc off
// 3D Parameters ------------------------------------------------------------- // 3D Parameters -------------------------------------------------------------
// @doc on
// Set the perspective of 3D transforms on the children of an element: // Set the perspective of 3D transforms on the children of an element:
// //
@ -193,7 +194,7 @@ $default-skew-y : 5deg !default;
// Determine the visibility of an element when it's back is turned // Determine the visibility of an element when it's back is turned
// //
// @include backface-visibility( [ visibility ] ) // @include backface-visibility( [ visibility ] )
// //
// where `visibility` can be either `visible` or `hidden` // where `visibility` can be either `visible` or `hidden`
// browsers default to visible, mixin defaults to hidden // browsers default to visible, mixin defaults to hidden
@ -440,11 +441,14 @@ $default-skew-y : 5deg !default;
@include transform3d($trans); @include transform3d($trans);
} }
// @doc off
// Skew ---------------------------------------------------------------------- // Skew ----------------------------------------------------------------------
// @doc on
// Skew an element // Skew an element:
// @include skew( [ skew-x, skew-y, 3D-only ] ) //
// @include skew( [ skew-x, skew-y, 3D-only ] )
//
// where the 'skew-' arguments accept css angles in degrees (deg) or radian (rad) units // where the 'skew-' arguments accept css angles in degrees (deg) or radian (rad) units
// //
// **Note** This mixin cannot be combined with other transform mixins. // **Note** This mixin cannot be combined with other transform mixins.
@ -458,7 +462,8 @@ $default-skew-y : 5deg !default;
} }
// Skew an element along the x axiz // Skew an element along the x axiz
// @include skew( [ skew-x, 3D-only ] ) //
// @include skew( [ skew-x, 3D-only ] )
// //
// **Note** This mixin cannot be combined with other transform mixins. // **Note** This mixin cannot be combined with other transform mixins.
@mixin skewX( @mixin skewX(
@ -470,7 +475,8 @@ $default-skew-y : 5deg !default;
} }
// Skew an element along the y axis // Skew an element along the y axis
// @include skew( [ skew-y, 3D-only ] ) //
// @include skew( [ skew-y, 3D-only ] )
// //
// **Note** This mixin cannot be combined with other transform mixins. // **Note** This mixin cannot be combined with other transform mixins.
@mixin skewY( @mixin skewY(