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.

Sign up for GitHub

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

Jump to bottom

DAML/JavaScript: Make naming in docs consistent #5475

Merged
merged 2 commits into from
Apr 7, 2020
Merged

DAML/JavaScript: Make naming in docs consistent #5475

merged 2 commits into from
Apr 7, 2020

Conversation

hurryabit
Copy link
Contributor

@hurryabit hurryabit commented Apr 7, 2020 •
edited
Loading

CHANGELOG_BEGIN
CHANGELOG_END

Pull Request Checklist

  • Read and understand the contribution guidelines
  • Include appropriate tests
  • Set a descriptive title and thorough description
  • Add a reference to the issue this PR will solve, if appropriate
  • Include changelog additions in one or more commit message bodies between the CHANGELOG_BEGIN and CHANGELOG_END tags
  • Normal production system change, include purpose of change in description

NOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with /AzurePipelines run to
trigger the build.

This change is Reviewable

@hurryabit hurryabit requested review from cocreature and bame-da April 7, 2020 17:14
@hurryabit hurryabit requested a review from nemanja-da as a code owner April 7, 2020 17:14
cocreature
cocreature approved these changes Apr 7, 2020
View reviewed changes
Copy link
Contributor

@cocreature cocreature left a comment

Choose a reason for hiding this comment

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

Thanks! I find the DAML/JavaScript thing slightly confusing since it sounds too much like or to me but I’ll leave the bikeshedding to you.

docs/source/app-dev/bindings-ts/daml2js.rst Outdated
@@ -1,18 +1,12 @@
.. Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
.. SPDX-License-Identifier: Apache-2.0

DAML to JavaScript code generation
##################################
DAML/JavaScript Code Generator
Copy link
Contributor

Choose a reason for hiding this comment

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

This sounds like you can generate either DAML or JavaScript. I find to to be easier to understand. Or just JavaScript codegentor.

docs/source/app-dev/bindings-ts/index.rst Outdated
@@ -1,13 +1,14 @@
.. Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
.. SPDX-License-Identifier: Apache-2.0

TypeScript bindings
###################
DAML/JavaScript Client Libraries
Copy link
Contributor

Choose a reason for hiding this comment

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

I’m not sure adding DAML in the name really helps. This is hosted on docs.daml.com. Anything that isn’t about DAML wouldn’t make sense here anyway.

docs/source/index.rst
@@ -42,7 +42,6 @@ DAML SDK documentation
:caption: Building applications

app-dev/app-arch
daml2js/index
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess this is intentional to only have a single entry point? Sounds reasonable to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that's intended for exactly that reason. 😃

bame-da
bame-da approved these changes Apr 7, 2020
View reviewed changes
Copy link
Contributor

@bame-da bame-da left a comment

Choose a reason for hiding this comment

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

I don't mind too much about DAML/. This works for me.

@hurryabit
Drop DAML/ prefix
13999db 
CHANGELOG_BEGIN
CHANGELOG_END
hurryabit
hurryabit commented Apr 7, 2020
View reviewed changes
Copy link
Contributor Author

@hurryabit hurryabit left a comment

Choose a reason for hiding this comment

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

I dropped all the DAML/ prefixed. I wasn't married to them anyway.

docs/source/index.rst
@@ -42,7 +42,6 @@ DAML SDK documentation
:caption: Building applications

app-dev/app-arch
daml2js/index
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that's intended for exactly that reason. 😃

@mergify mergify bot merged commit 26f073b into master Apr 7, 2020
@mergify mergify bot deleted the daml-js-docs branch April 7, 2020 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bame-da bame-da bame-da approved these changes

@cocreature cocreature cocreature approved these changes

@nemanja-da nemanja-da Awaiting requested review from nemanja-da

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hurryabit @cocreature @bame-da