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

Note deprecation of constant keyword on functions #3426

Merged
merged 1 commit into from
Feb 26, 2018

Conversation

wbt
Copy link
Contributor

@wbt wbt commented Jan 23, 2018

@@ -467,7 +467,7 @@ The following statements are considered modifying the state:
}

.. note::
``constant`` is an alias to ``view``.
``constant`` is an alias to ``view``, but this is `deprecated <https://github.com/ethereum/solidity/issues/992#issuecomment-322351715>`_ and will be removed in the next breaking release.
Copy link
Contributor

Choose a reason for hiding this comment

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

You do not have to cite github issues in the documentation. :)
Please also mention version 0.5.0 explicitly, not only relatively.

@wbt
Copy link
Contributor Author

wbt commented Jan 26, 2018

Thanks for clarifying the version number, I wasn't 100% sure and didn't want to edit in the wrong one.

Though I appreciate that it's not required, I think the link to the GitHub issue where this was decided is appropriate, as somebody will be following old code/tutorials with constant, run into a problem, and want to know when and why the change was made. The hyperlink is a big step toward answering such questions without any additional screen real estate or reading time. Also, there are plenty of other links pointing to that issue from other places saying the same thing.

@@ -467,7 +467,7 @@ The following statements are considered modifying the state:
}

.. note::
``constant`` is an alias to ``view``.
``constant`` was an alias to ``view``, but this is `deprecated <https://github.com/ethereum/solidity/issues/992#issuecomment-322351715>`_ and has been removed as of version 0.5.0.
Copy link
Member

Choose a reason for hiding this comment

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

There wasn't a 0.5.0 release yet, so this cannot be past tense. Also please do not include the github comment as it is irrelevant. This is the official documentation, no need to prove the content with links to issues.

@axic
Copy link
Member

axic commented Feb 26, 2018

Squashed, rebased and reworded.

@chriseth chriseth merged commit 3aaa5c4 into ethereum:develop Feb 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants