Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Misc doc updates #1461

Merged
merged 19 commits into from Apr 9, 2014
Merged

Misc doc updates #1461

merged 19 commits into from Apr 9, 2014

Commits on Apr 5, 2014

  1. Standardize capitalization of scenarios. 

    When viewing in Relish, scenarios read as section titles. General
punctuation dictates that section titles should start capitalized.
    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    312f929 View commit details
    Browse the repository at this point in the history

  2. Use a more explicit scenario description.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    91f4e6b View commit details
    Browse the repository at this point in the history

  3. Update feature description.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    f4361d1 View commit details
    Browse the repository at this point in the history

  4. Standardize on RSpec.describe over describe.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    bf37a20 View commit details
    Browse the repository at this point in the history

  5. Surround inline code in back ticks.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    eb02899 View commit details
    Browse the repository at this point in the history

  6. Correct note about x-aliases now skipping.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    1a40a32 View commit details
    Browse the repository at this point in the history

  7. Make CLI flags explicit across features.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    eddecbd View commit details
    Browse the repository at this point in the history

  8. Adjust grammar and HTML rendering. 

    - Explicitly specify the code block format for Relish
- Adjust wording to keep related topics together
    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    bbe256f View commit details
    Browse the repository at this point in the history

  9. Add skip to CLI output --format scenarios.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    6f7a193 View commit details
    Browse the repository at this point in the history

  10. Add new scenario describing a simple name alias. 

    Adjust the spec file names to match the description.
    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    f9698b9 View commit details
    Browse the repository at this point in the history

  11. Whitespace only update.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    d69b368 View commit details
    Browse the repository at this point in the history

  12. Replace order feature with basic description.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    94f9cb8 View commit details
    Browse the repository at this point in the history

  13. Use code backticks in feature and scenario names.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    c0a6860 View commit details
    Browse the repository at this point in the history

  14. Use triple backticks for description code blocks. 

    Relish supports using triple backticks for code blocks in markdown. This
is primarily used in feature descriptions. Relish has a few issues with
supporting naming the syntax with triple backticks. We'll standardize on
this method while Relish works the remaining issues out.
    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    f44ec40 View commit details
    Browse the repository at this point in the history

  15. Minor grammatical update. 

    - Bold notes, warnings, etc. titles
- Move convention into a sub-heading
    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    c468279 View commit details
    Browse the repository at this point in the history

  16. Standardize on RSpec.describe over describe.

    @cupakromer
    cupakromer committed Apr 5, 2014
    Configuration menu
    Copy the full SHA
    f3a1a8a View commit details
    Browse the repository at this point in the history

Commits on Apr 8, 2014

  1. Update allowed syntax to remove should by default. 

    - Remove one-liner `should` and `should_not`
- Allow for full override of the customizations
    @cupakromer
    cupakromer committed Apr 8, 2014
    Configuration menu
    Copy the full SHA
    49ca43e View commit details
    Browse the repository at this point in the history

  2. Include new doc standards with new feature. 

    Adjust whitespace for feature description based on space taken by added
tags.
    @cupakromer
    cupakromer committed Apr 8, 2014
    Configuration menu
    Copy the full SHA
    26e41c8 View commit details
    Browse the repository at this point in the history

  3. A few more minor grammar and formatting updates.

    @cupakromer
    cupakromer committed Apr 8, 2014
    Configuration menu
    Copy the full SHA
    cccb32b View commit details
    Browse the repository at this point in the history