Skip to content

Zune documentation issues #125

@EternalAbby

Description

@EternalAbby

Here is a list of issues I found on the Zune documentation:

  • Properties and functions should be prefixed with the dot operator (".") to be clearer. This will also be consistent with methods while also giving enough clarity on how to access it.
  • When viewing in dark mode, the highlights from the search bar makes it difficult to view the highlighted word, because it blends with the word color.
  • Adding onto above, the search bar only highlights entire word. There isn't any highlights for individual matched characters. (This is more on the issue of Nextra Search pathfind backend, which does not have an option to do this so far, this would be out of scope of what the documentation page can do.)
  • testing.expected - Description can be stated as "Expects the value to be a truthy value." Stating truthy value would suffice "true or non nil" in Lua/Luau. However, if needed, explaining briefly the term may also be good.
  • zune luau --list-fflag - FFlags are Fast Flags, not Feature Flags. This term can be found in the source code of Luau.
  • Most functions in fs library has a path parameter which takes in a string. Their description does not state that it allows require-by-string semantic, which creates ambiguity to the user.
  • Adding onto above, it also does not state where the starting directory is, which also creates ambiguity. The starting directory is at the location of the Zune program, which may be a bug from issue Opening a file in Zune to run a Luau script does not respect require-by-string #124.
  • serde.yaml.decode - YamlOuput may be a typo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions