Skip to content

Improve the documentation about automatic metadata#1543

Merged
JonRowe merged 1 commit intorspec:masterfrom
jalkoby:master
Feb 3, 2016
Merged

Improve the documentation about automatic metadata#1543
JonRowe merged 1 commit intorspec:masterfrom
jalkoby:master

Conversation

@jalkoby
Copy link
Copy Markdown

@jalkoby jalkoby commented Jan 31, 2016

Continuing the conversation #1541

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads weirdly, how about To enable automatic metadata for other folders, useRSpec::Configuration#define_derived_metadata`, for an example see below:

@jalkoby
Copy link
Copy Markdown
Author

jalkoby commented Feb 2, 2016

@JonRowe I've updated the wording and change the regexp

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this line as rather needless as the line directly above it says that: "If you follow the above listed canonical directory structure..." And the canonical structure mentioned is the very first thing this document goes over in detail.

Perhaps we can remove this line and just change the one below to "If you want to set metadata for a custom directory that doesn't follow fit the canonical structure above, you can do the following:" ? (Note I changed folder -> directory as well, since the rest of the document uses directory, not folder. Consistency FTW!)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jalkoby jalkoby force-pushed the master branch 2 times, most recently from 1626e75 to c7f7040 Compare February 3, 2016 14:05
@jalkoby
Copy link
Copy Markdown
Author

jalkoby commented Feb 3, 2016

The wording was changed. Also I found the reason of spec failing - cucumber needs a zero-length space before "#" comment symbol

JonRowe added a commit that referenced this pull request Feb 3, 2016
Improve the documentation about automatic metadata
@JonRowe JonRowe merged commit 74131b2 into rspec:master Feb 3, 2016
@JonRowe
Copy link
Copy Markdown
Member

JonRowe commented Feb 3, 2016

Thanks ❤️

@chrisarcand
Copy link
Copy Markdown

👍 👍

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.

3 participants