zaphar/ucg
1
0
Fork 0
mirror of https://github.com/zaphar/ucg.git synced 2025-07-23 18:29:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

MAINT: Documentation updtes for the output statement.

Browse Source
This commit is contained in:
Jeremy Wall 2018-11-06 18:14:01 -06:00
parent c9180dffeb
commit be4feb12ba
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/lib.rs
View File

@ -425,10 +425,22 @@
//!
//! * Out statement
//!
//! The out statement defined the output for a UCG file. It identifies an expression that will be output as a
//! compiled artifact by the UCG compiler was well as the artifact type. The artifact type is expected to be one
//! of the registered converters (e.g. json, exec) and the artifact file will take the same name as the ucg file
//! with the extension replaced by the defined extension for that converter.
//! The out statement defines the output for a UCG file. It identifies the output converter type and an
//! expression that will be output. The output converter type is expected to be one of the registered converters
//! (e.g. json, exec) and the artifact file will take the same name as the ucg file with the extension replaced by
//! the defined extension for that converter.
//!
//! For a file named api_config.ucg with the following contents:
//!
//! ```ucg
//! let myconf = {
//! api_url = "https://example.org/api/v1/",
//! api_token = env.API_TOKEN,
//! };
//! out json myconf;
//! ```
//!
//! ucg will output the myconf tuple as json to a file called api_config.json
//!
//! ### Converters
//!