Vyper: Documentation for compiler API

Created on 30 Apr 2019  路  2Comments  路  Source: vyperlang/vyper

It would be nice to have more documentation (and doctests) for the compiler API. This is endpoint that will support other tools, so it should really clear how to interact with it and what the options are. Also, if we allow deeper integration into the compilation stages, this will be really important to document what each stage takes as input and output.

Easy Pickings documentation

Most helpful comment

Good idea, I would just make this a "Integrating Vyper" section.

All 2 comments

Good idea, I would just make this a "Integrating Vyper" section.

We have https://github.com/vyperlang/vyper/tree/master/vyper/compiler and the docstrings for compile_code and compile_codes are fairly extensive. Should we still consider a section in the actual documentation, or can we consider this good enough?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

nrryuya picture nrryuya  路  4Comments

haydenadams picture haydenadams  路  3Comments

denis-bogdanas picture denis-bogdanas  路  3Comments

ben-kaufman picture ben-kaufman  路  3Comments

vici0 picture vici0  路  3Comments