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.

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

Misc doc updates #1447

Closed
wants to merge 6 commits into from
Closed

Misc doc updates #1447

wants to merge 6 commits into from

Conversation

cupakromer
Copy link
Member

Starting to do a complete review of all the Relish docs. I often find myself using these daily or trying to point users to them. I've created a list of things that need updating / adding. This is the first pass on the core docs fixing mostly minor issues.

There are a few consistency issues I'd like to get some guidance one / set a standard:

  • Capitalize the first word of scenarios; these read more like sentences and section titles, which should be capitalized
  • Use back ticks for inline code consistently

DO NOT MERGE YET

@myronmarston
Copy link
Member

Thanks for taking this on, @cupakromer! They definitely need a refresh.

We have a couple open issues about this that hopefully you can address as part of this:

In addition, one other thing I'd like to do is update all the cukes to use RSpec.describe rather than bare describe so users are made aware of the non-monkey-patched version. (Prior discussion: #1219 (comment) )

As part of that, it'd be good to enforce that. You can see how we enforce it in rspec-expectations:

rspec/rspec-expectations@75a470f

@cupakromer
Copy link
Member Author

@myronmarston thanks for the feedback. I was going to make a separate pass just for the back ticks. I was trying not to just whole sale re-arrange an entire file; though it is probably easier to make all changes at once. I'll be sure to adjust things.

I have a relish app beta account and I'm pointing my local rspec repos to it as I go. That way I can preview what it looks like before committing.

@myronmarston
Copy link
Member

Sounds good, @cupakromer!

@cupakromer
Copy link
Member Author

Closing in favor of new branch on core repo. See #1461

@cupakromer cupakromer closed this Mar 28, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants