Vyper: Add documentation for exceptions

Created on 8 Aug 2019  路  16Comments  路  Source: vyperlang/vyper

What's your issue about?

Add docstrings and generate documentation for compiler exceptions. This would really help others figure out what issues they're encountering and how to fix them.

Details

Add a section detailing all possible compiler exceptions, and under what scenarios you are likely to see them. Include examples. Also include what to do if you run into a Python backtrace or CompilerPanic exception

Extras

Add links to compiler exception messages to the documentation, to make it easier to find.

Easy Pickings bounty documentation enhancement help wanted

Most helpful comment

I am going to apply for this Bounty. I can get it done within a week.

All 16 comments

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


__This issue now has a funding of 100.0 DAI (100.0 USD @ $1.0/DAI) attached to it.__

@iamonuwa thanks for taking this on! Let us know in the gitter if you have any questions!

@iamonuwa thanks for taking this on! Let us know in the gitter if you have any questions!

Hey @fubuloubu glad am working on this with you.

@iamonuwa any updates on this?

@iamonuwa any updates on this?

Hey, it will be available today

@fubuloubu does this issue still need work? Found it through gitcoin.

Yes @adrianhacker-pdx this bounty is still open!

Also note that it's paid in Sai 馃槵

I am going to apply for this Bounty. I can get it done within a week.

Thank you!

@fubuloubu
Hello, I have opened a pull request with the documentation updates requested.
However you would prefer to handle the bounty, just lemme know, I have listed my gitcoin and my direct address :). I will handle any feedback issues that you have prior to merging. Thanks for the work.

https://github.com/vyperlang/vyper/pull/1853 is the pull request.
https://gitcoin.co/adrianhacker-pdx is my gitcoin profile, or you can use my sai address directly:
0xcF24939b6C28196b1DA830b07D138ea8E2AA8ab5

Looking good, we will check it out!

@fubuloubu is there any way not waiting forever to get the bounty payment can be a thing (sorry, ive had a streak of doing work then getting ignored lately)

@iamdefinitelyahuman is taking a look over, we should have it all figured out by the end of the week. I think he wanted to see some changes.

@adrianhacker-pdx can you please claim the bounty? I unassigned the previous person.

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


__Work has been started__.

These users each claimed they can complete the work by 5聽months, 3聽weeks from now.
Please review their action plans below:

1) adrianhacker-pdx has started work.

Do the job. Make corrections via feedback given.

Learn more on the Gitcoin Issue Details page.

@fubuloubu claimed it on gitcoin. I'll handle any feedback and modifications until happiness happens.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

pipermerriam picture pipermerriam  路  3Comments

fubuloubu picture fubuloubu  路  3Comments

fubuloubu picture fubuloubu  路  3Comments

jacqueswww picture jacqueswww  路  3Comments

jakerockland picture jakerockland  路  4Comments