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 documentation for DAML repl and advertise it #4678

Merged
merged 3 commits into from
Feb 25, 2020
Merged

Conversation

cocreature
Copy link
Contributor

This PR adds some simple docs for daml repl and adds it to the
release notes.

changelog_begin

  • [DAML Repl - Experimental] A new daml repl command that allows
    you to use the DAML Script API interactively. Take a look at the
    documentation <https://docs.daml.com/daml-repl/>_ for more
    information.

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 PR adds some simple docs for ``daml repl`` and adds it to the
release notes.

changelog_begin

- [DAML Repl - Experimental] A new ``daml repl`` command that allows
  you to use the ``DAML Script`` API interactively. Take a look at the
  `documentation <https://docs.daml.com/daml-repl/>`_ for more
  information.

changelog_end
Copy link
Contributor

@aherrmann-da aherrmann-da left a comment

Choose a reason for hiding this comment

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

Looks great!

Minor comment.

docs/source/daml-repl/index.rst Outdated Show resolved Hide resolved
docs/source/daml-repl/index.rst Outdated Show resolved Hide resolved
command "repl" $
info (helper <*> cmd) fullDesc
command "repl" $ info (helper <*> cmd) $
progDesc "Launch the DAML Repl." <>
Copy link

Choose a reason for hiding this comment

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

"REPL" is typically all caps; it's an acronym. Can I suggest using "REPL" everywhere user-facing rather than "Repl" or "repl"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I actually looked this up and got mislead by Repl.it thinking that this is the spelling people commonly use. I’ve changed it now.

cocreature and others added 2 commits February 25, 2020 11:30
Co-Authored-By: Andreas Herrmann <42969706+aherrmann-da@users.noreply.github.com>
@mergify mergify bot merged commit 38b7e65 into master Feb 25, 2020
@mergify mergify bot deleted the daml-repl-docs branch February 25, 2020 11:16
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