Skip to content

[DOCS] Improve imports documentation #6153

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

Merged
merged 1 commit into from
Mar 6, 2019
Merged

[DOCS] Improve imports documentation #6153

merged 1 commit into from
Mar 6, 2019

Conversation

ChrisChinchilla
Copy link
Contributor

@ChrisChinchilla ChrisChinchilla commented Mar 4, 2019

Description

As mentioned here #4981 (comment) this PR attempts to make the import documentation clearer and easier to follow.

Checklist

  • Code compiles correctly
  • All tests are passing
  • New tests have been created which fail without the change (if possible)
  • README / documentation was extended, if necessary
  • Changelog entry (if change is visible to the user)
  • Used meaningful commit messages

@@ -96,7 +96,7 @@ The component does not yet support all features of the Solidity language
and likely outputs many warnings. In case it reports unsupported
features, the analysis may not be fully sound.

.. index:: source file, ! import
.. index:: source file, ! import, module
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not set on leaving this, was just adding terms that people might look for.

@ChrisChinchilla ChrisChinchilla marked this pull request as ready for review March 4, 2019 13:08
erak
erak previously approved these changes Mar 5, 2019
Copy link
Contributor

@chriseth chriseth left a comment

Choose a reason for hiding this comment

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

Please squash, otherwise fine.

Continue import polish
@codecov
Copy link

codecov bot commented Mar 6, 2019

Codecov Report

Merging #6153 into develop will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #6153      +/-   ##
===========================================
+ Coverage    87.94%   87.95%   +<.01%     
===========================================
  Files          377      374       -3     
  Lines        36091    35718     -373     
  Branches      4268     4216      -52     
===========================================
- Hits         31739    31414     -325     
+ Misses        2915     2889      -26     
+ Partials      1437     1415      -22
Flag Coverage Δ
#all 87.95% <ø> (ø) ⬆️
#syntax ?

@ChrisChinchilla
Copy link
Contributor Author

@chriseth Squashed and rebased

@chriseth chriseth merged commit ee4beaf into develop Mar 6, 2019
@axic axic deleted the docs-imports branch March 22, 2019 11:25
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