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

Review Address.md #340

Closed
wants to merge 1 commit into from
Closed

Conversation

cduangprom
Copy link
Contributor

First review of these files, need to clarify some of the content. Questions in comments.

First review of these files, need to clarify some of the content. Questions in comments.
@boolafish
Copy link
Contributor

I haven’t fully take into the PR yet, but all doc here is auto generated via code document. And sadly this Address file is actually from open zeppelin which we don’t have control. ( we use it as dependency and the doc gen tool pulled that in too)

@cduangprom
Copy link
Contributor Author

@boolafish I'm aware the doc is auto-generated, that's fine, but can the output seen in the .md file be edited? Gerhard requested I review these files for language and formatting. He said I could edit and create the PR. The first PR is exploratory, thus my questions. Are the doc files in this repo the final output to show to audience?

@cduangprom cduangprom closed this Oct 11, 2019
@cduangprom cduangprom reopened this Oct 11, 2019
@cduangprom
Copy link
Contributor Author

Somehow the pr closed with my last comment

@cduangprom
Copy link
Contributor Author

@boolafish Gerhard has just advised I should take a look at source files instead, in the code at https://github.com/omisego/plasma-contracts/tree/master/plasma_framework/contracts/src.

@cduangprom cduangprom closed this Oct 11, 2019
@boolafish
Copy link
Contributor

Oh yeah, if any change you’d like to make should be on source code directly. Just sadly the file edited in this PR it is out of our control

@cduangprom
Copy link
Contributor Author

@boolafish latest natspec format is now v0.5.12. Will you continue with v0.5.11 or will the auto-generate automatically apply v0.5.12 when you next generate docs. I'm sure minor differences only just want to check

@boolafish
Copy link
Contributor

I am guessing you means our solidity version. My plan is to keep 0.5.11 for a while and move to 0.5.12 before audit. (Assuming we prefer latest version for audit) See previous discussion here: #328 (comment)

I doubt it would have any impact on the doc here, but will make sure we re-generate the doc again.

@cduangprom cduangprom deleted the patch-1 branch October 16, 2019 05: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