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

Unify Language/ examples output style #1181

Merged
merged 7 commits into from Feb 11, 2017
Merged

Conversation

Altai-man
Copy link
Member

No more #->. No more #=>. No more # OUTPUT<<(all of these could be mixed even in a single file). Just our plain unified style described here: #776 (comment)
This is a final stage of formatting work, there will be (hopefully) no more such PRs.

@Altai-man
Copy link
Member Author

Altai-man commented Feb 4, 2017

The PR somewhat grew today, hence the explanation:

  • New fixes for the examples.
  • (important) The actual test of compiled examples was added.

This test:
1)Extracts examples from documentation;
2)Tries to compile it;
3)If the exitcode is 0, then it's okay, otherwise changes was bad.
We skip unsuitable or infinite examples by :skip-test directive. As for now, all documentation passes this test(with changes included in this PR).

Why do we need this? Okay, during my journey into the documentation, I've reviewed it entirely and found quite a lot of bugs, broken examples, mistakes in comments, etc. Documentation and code surely start to rot with time, but we can at least prevent this a little.

cast @AlexDaniel, @gfldex, @coke for reviewing, discussing, merging/rejecting.

@Altai-man Altai-man requested a review from coke February 6, 2017 17:35
Copy link
Collaborator

@coke coke left a comment

Choose a reason for hiding this comment

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

Looks good

@Altai-man Altai-man merged commit 67b1dfa into master Feb 11, 2017
@Altai-man Altai-man deleted the language-section-examples2 branch February 11, 2017 19:31
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