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

Grammar nits #156

Merged
merged 2 commits into from Jul 1, 2019
Merged

Grammar nits #156

merged 2 commits into from Jul 1, 2019

Conversation

joepetrowski
Copy link
Contributor

We need to make a decision on srml_contract vs. srml_contracts.

@@ -39,11 +39,11 @@ You can build your own custom module by deriving from the system module (describ

The following are the modules that ship with the SRML.

* [Assets]()
* [Assets](https://crates.parity.io/srml_assets/index.html)
Copy link
Contributor

Choose a reason for hiding this comment

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

All of the other links in this list go to the v1.0 rustdocs here on substrate.dev. Why is https://substrate.dev/rustdocs/v1.0/srml_assets/index.html 404?

I'd prefer not mixing the links especially because crates.parity.io seems to follow master.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same, but it looks bad if the first thing in the list doesn't go anywhere.

@JoshOrndorff
Copy link
Contributor

JoshOrndorff commented Jul 1, 2019

I agree that we need to decide on contract vs contracts. I don't have an opinion about which we choose have a slight preference for plural. Both the code directory and the doc comments, use the singular. After this PR the docs use plural.

https://github.com/paritytech/substrate/blob/v1.0/srml/contract/src/lib.rs#L17

@joepetrowski
Copy link
Contributor Author

I agree that we need to decide on contract vs contracts. I don't have an opinion about which we choose have a slight preference for plural. Both the code directory and the doc comments, use the singular. After this PR the docs use plural.

https://github.com/paritytech/substrate/blob/v1.0/srml/contract/src/lib.rs#L17

The v1.0 branch uses contract and master uses contracts. I'd say use contracts here to avoid rework when we upgrade to v2.0. Obviously use "contract" in links where necessary.

@JoshOrndorff JoshOrndorff merged commit f7fd16f into source Jul 1, 2019
@JoshOrndorff JoshOrndorff mentioned this pull request Jul 1, 2019
3 tasks
@joepetrowski joepetrowski deleted the joe-grammar-nits branch July 1, 2019 19:53
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.

None yet

2 participants