Skip to content

Issues in documentation for parsing #3157

@dvd101x

Description

@dvd101x

Hi,

Documentation states that in a parser getAll() retrieves a map, but it's an object.

- `getAll()`
Retrieve a map with all defined a variables from the parser's scope.

The one that retrieves a map is getAllAsMap but it's not documented, fixing the grammatical error of "defined a variables" probably should be:

  • getAll()
    Retrieve an object with all defined variables in the parser's scope.
  • getAllAsMap()
    Retrieve a map with all defined variables in the parser's scope.

Reference

/**
* Get a map with all defined variables
* @return {Object} values
*/
Parser.prototype.getAll = function () {
return toObject(this.scope)
}
/**
* Get a map with all defined variables
* @return {Map} values
*/
Parser.prototype.getAllAsMap = function () {
return this.scope
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationConcerns about or enhancements to the mathjs documentationhelp wanted

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions