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

Improve the binding configuration documentation #182

Merged
merged 3 commits into from
Sep 3, 2018
Merged

Conversation

jonas
Copy link
Member

@jonas jonas commented Aug 28, 2018

Extracted from #179

Copy link
Member

@kornilova203 kornilova203 left a comment

Choose a reason for hiding this comment

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

awesome work, thank you!


### Using Types From the Scala Native Bindings

Similar to the above, the following this example shows how you can use
Copy link
Member

Choose a reason for hiding this comment

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

I think this should not be here

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch 👍

.name("stdlib")
.packageName("org.example.app.stdlib")
//#sbt-exclude-prefix
.excludePrefix("__")
Copy link
Member

Choose a reason for hiding this comment

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

I noticed that rendered snippet does not have indent on second line:

NativeBinding(resourceDirectory.value / "stdlib.h")
.excludePrefix("__")

It can be fixed by changing comment indent:

        .packageName("org.example.app.stdlib")
       //#sbt-exclude-prefix
         .excludePrefix("__")

Copy link
Member

Choose a reason for hiding this comment

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

this also applies to build.sbt:173

@jonas jonas force-pushed the binding-config-docs branch from 3d0a59a to 4ba6d11 Compare September 3, 2018 20:28
@jonas jonas merged commit 383da84 into master Sep 3, 2018
@jonas jonas deleted the binding-config-docs branch September 3, 2018 20:46
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