Skip to content

hclparse package comment references nonexistent functions #793

@ChandlerSwift

Description

@ChandlerSwift

The comment at the top of the hclparse package references hcl.SimpleParse, hcl.SimpleParseFile, and gohcl.SimpleDecode:

hcl/hclparse/parser.go

Lines 7 to 11 in 2efc266

// The main HCL package also includes SimpleParse and SimpleParseFile which
// can be a simpler interface for the common case where an application just
// needs to parse a single file. The gohcl package simplifies that further
// in its SimpleDecode function, which combines hcl.SimpleParse with decoding
// into Go struct values

However, I was unable to find reference to any of these, e.g. the only reference to SimpleParse in this repo is in the hclparse package comment:

https://github.com/search?q=repo%3Ahashicorp%2Fhcl%20SimpleParse&type=code

I'm guessing this may be a holdover from hcl/v1 and isn't applicable to hcl/v2.

Should the comment either be updated to point at the correct resources or removed?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions