hcl/hcled/doc.go

// Package hcled provides functionality intended to help an application
// that embeds HCL to deliver relevant information to a text editor or IDE
// for navigating around and analyzing configuration files.
package hcled
Update doc comments and readmes for zcl -> HCL. 2017-09-11 23:56:31 +00:00			`// Package hcled provides functionality intended to help an application`
			`// that embeds HCL to deliver relevant information to a text editor or IDE`
Mechanism for introspection of source code for editors The new "Nav" member on a zcl.File is an opaque object that can be populated by parsers with an object that supports certain interfaces that are not part of the main API but are useful for integration with editors and other tooling. As a first example of this, we replace the hack for getting context in the diagnostic package with a new ContextString interface, which can then be optionally implemented by a given parser to return a contextual string native to the source language. 2017-05-20 01:56:39 +00:00			`// for navigating around and analyzing configuration files.`
Rename the ancillary packages from "zcl" to "hcl". The main "zcl" package requires a bit more care because of how many callers it has and because of its two subpackages, so we'll take care of that one separately. 2017-09-11 23:00:31 +00:00			`package hcled`