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

Update README #810

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README #810

wants to merge 2 commits into from

Conversation

QubitPi
Copy link
Contributor

@QubitPi QubitPi commented May 8, 2019

Resolves # (if appropriate)

Description

Elide standalone startup throws unchecked exception which hasn't been captured in doc yet

A docker image has been introduced to give new users a quicker and easier experience of Elide (If core team likes it)

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

@coveralls
Copy link
Collaborator

coveralls commented May 8, 2019

Coverage Status

Coverage remained the same at 76.042% when pulling f0d2239 on QubitPi:update-README into c639f6f on yahoo:master.

@@ -33,7 +33,7 @@ To actually start your Elide application, add the following to your main method:

```java
public class Main {
public static void main(String[] args) {
public static void main(String[] args) throws Exception {
Copy link
Collaborator

@DennisMcWherter DennisMcWherter May 9, 2019

Choose a reason for hiding this comment

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

Rather than adding the unchecked exception to the signature, I would suggest adding it to the javadoc. Especially since this is on the main method, there is no one else to really catch it.

Same comment for the others.

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.

3 participants