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

Rewrite documentation with full example #69

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@fulldecent
Copy link

fulldecent commented Apr 4, 2019

No description provided.

@CLAassistant

This comment has been minimized.

Copy link

CLAassistant commented Apr 4, 2019

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@sohkai
Copy link
Member

sohkai left a comment

❤️ Thanks!

Would be great if you could sign the CLA 😄

}
```

Notice the *dynamic expression* documentation for the `age` function. When presented to the end user, this will render based on the inputs provided by the user. For example, if the end user is calling the contract with an input of 10 years, this is specified to render as:

This comment has been minimized.

Copy link
@sohkai

sohkai Apr 4, 2019

Member
Suggested change
Notice the *dynamic expression* documentation for the `age` function. When presented to the end user, this will render based on the inputs provided by the user. For example, if the end user is calling the contract with an input of 10 years, this is specified to render as:
Notice the *dynamic expression* documentation for the `setAge` function. When presented to the end user, this will render based on the inputs provided by the user. For example, if the end user is calling the contract with an input of 10 years, this is specified to render as:

> Set the tree age to 10 years
Use the Solitidy compiler to generate user documentation and ABI with:

This comment has been minimized.

Copy link
@sohkai

sohkai Apr 4, 2019

Member
Suggested change
Use the Solitidy compiler to generate user documentation and ABI with:
Use the Solidity compiler to generate user documentation and ABI with:
type: 'uint256'
}]
}],
abi: abi,
transaction: {
to: '0x8521742d3f456bd237e312d6e30724960f72517a',
data: '0xc6888fa1000000000000000000000000000000000000000000000000000000000000007a'

This comment has been minimized.

Copy link
@sohkai

sohkai Apr 4, 2019

Member

This should probably be changed to reflect the actual calldata for setAge(10)?


## Aside: Why is natspec unsafe?

Natspec accepts any valid JavaScript. There are multiple reasons this is a bad idea:

This comment has been minimized.

Copy link
@sohkai

sohkai Apr 4, 2019

Member

I think this section is still important, but we should make it clear this is about the JS library for natspec (https://github.com/ethereum/natspec.js).

@@ -3,43 +3,89 @@
[![Travis branch](https://img.shields.io/travis/aragon/radspec/master.svg?style=flat-square)](https://travis-ci.org/aragon/radspec)
[![Coveralls github branch](https://img.shields.io/coveralls/github/aragon/radspec/master.svg?style=flat-square)](https://coveralls.io/github/aragon/radspec)

Radspec is a safe alternative to Ethereum's natspec[[?](#aside-why-is-natspec-unsafe)].
Radspec is a language specification and interpreter for dynamic expressions in Ethereum's NatSpec.

This comment has been minimized.

Copy link
@sohkai

sohkai Apr 4, 2019

Member

I think people are sometimes confused between NatSpec, the specification, and natspec.js, its original evaluator. Can we do something the clear that up here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.