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

Add DSL docs and update bootstrap project #226

Merged
merged 26 commits into from
Mar 11, 2016
Merged

Conversation

dan-blanchard
Copy link
Member

I think this is good enough for a preview release now.

Rendered docs available on RTD here

@dan-blanchard dan-blanchard added this to the v3.0 milestone Mar 1, 2016
@dan-blanchard dan-blanchard changed the title [WIP] Add DSL docs and update bootstrap project Add DSL docs and update bootstrap project Mar 3, 2016
@dan-blanchard
Copy link
Member Author

I believe I've finally got all the relevant DSL things updated for the preview release. You can see this branch on RTD (if you have the direct link) here.

@dan-blanchard
Copy link
Member Author

Bah, forgot the stupid quickstart instructions. Doing those now.

@dan-blanchard
Copy link
Member Author

Okay, now it's good.

@rduplain
Copy link
Contributor

Add method link to emit_direct in streamparse.Grouping API docs:

:meth:`~...emit_direct`

You must either specify this, or
both ``full_class_name`` and ``args_list``.
:type serialized_java: `bytes`
:param full_class_name: Full name of Java class, including namespaces.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose that "including namespaces" makes sense to a Python developer, but a Java developer would think of it as "fully qualified class name, i.e. include the package name".

@rduplain
Copy link
Contributor

This looks great. I added some minor comments. Once addressed, +1 to merge.

dan-blanchard added a commit that referenced this pull request Mar 11, 2016
Add DSL docs and update bootstrap project
@dan-blanchard dan-blanchard merged commit a89b518 into master Mar 11, 2016
@dan-blanchard dan-blanchard deleted the feature/dsl_docs branch March 11, 2016 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants