Skip to content

[BEAM-5123] Documentation examples #19

Merged
VaclavPlajt merged 5 commits intovasek/testsuit-fixfrom
vasek/docs-improvements
Aug 21, 2018
Merged

[BEAM-5123] Documentation examples #19
VaclavPlajt merged 5 commits intovasek/testsuit-fixfrom
vasek/docs-improvements

Conversation

@VaclavPlajt
Copy link
Copy Markdown

This pull request includes documentation examples in form of tests. Some other fixes/updates to issues discovered when writing documentation.


Follow this checklist to help us incorporate your contribution quickly and easily:

  • Format the pull request title like [BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replace BEAM-XXX with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

It will help us expedite review of your Pull Request if you tag someone (e.g. @username) to look at it.

Post-Commit Tests Status (on master branch)

Lang SDK Apex Dataflow Flink Gearpump Samza Spark
Go Build Status --- --- --- --- --- ---
Java Build Status Build Status Build Status Build Status Build Status Build Status Build Status
Python Build Status --- Build Status
Build Status
--- --- --- ---

@VaclavPlajt VaclavPlajt changed the title [BEAM-5123] Documentaion examples [BEAM-5123] Documentation examples Aug 15, 2018
Copy link
Copy Markdown

@mareksimunek mareksimunek left a comment

Choose a reason for hiding this comment

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

Very nice doc examples.


/**
* Contains all the examples from documentation page. Not all of them contains asserts, some do, but
* thee rest is often here just to confirm that they compile. Once something break or changes, the
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

typo

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Fixed.

}

/**
* Note that this one is not mentioned in documentation since due to hih number of RBK examples
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

typo high

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Fixed.

@VaclavPlajt VaclavPlajt force-pushed the vasek/docs-improvements branch from 62e78a1 to 336ce8e Compare August 20, 2018 14:14
@VaclavPlajt VaclavPlajt force-pushed the vasek/docs-improvements branch from 2c23bcf to 2302f94 Compare August 21, 2018 10:54
@VaclavPlajt VaclavPlajt merged this pull request into vasek/testsuit-fix Aug 21, 2018
@VaclavPlajt VaclavPlajt deleted the vasek/docs-improvements branch August 21, 2018 10:55
@VaclavPlajt VaclavPlajt restored the vasek/docs-improvements branch August 21, 2018 14:10
@VaclavPlajt VaclavPlajt deleted the vasek/docs-improvements branch August 21, 2018 14:12
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.

2 participants