Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation, Environment global properties, containers #83

Merged
merged 6 commits into from
Aug 22, 2024

Conversation

harrymkt
Copy link
Contributor

@harrymkt harrymkt commented Aug 18, 2024

  • Array: insert_at, and remove_at, with their examples.
  • Environment global properties: PLATFORM, PLATFORM_DISPLAY_NAME, PLATFORM_VERSION, system_node_name, and system_node_id.
  • Dictionary has been documented and put into containers
  • File class has been documented in filesystem.

* Array: `insert_at`, and `remove_at`, with their examples.
* Environment global properties: `PLATFORM`, `PLATFORM_DISPLAY_NAME`, `PLATFORM_VERSION`, `system_node_name`, and `system_node_id`.
@harrymkt harrymkt changed the title Documentation, Environment global properties, array Documentation, Environment global properties, containers Aug 18, 2024
@samtupy
Copy link
Owner

samtupy commented Aug 18, 2024

Hi,

Thanks much for this documentation!

One thing, can you please fix instances of:

## Arguments
>=
## Arguments:

And similar for remarks and example in various documents?

Otherwise this is a great help, thanks again!

@harrymkt
Copy link
Contributor Author

Hello @samtupy.

I will fix it. Just I did it with colons is because I saw it without colon on string::format method.
Thanks, and I'll fix them in the new commit.

@TheQuinbox
Copy link
Collaborator

@harrymkt, you're right, weirdly the format method was missing colons on its headings too. I've gone ahead and fixed this, thanks!

harrymkt and others added 3 commits August 22, 2024 11:43
* moved the file documentation to the streams folder as it is a datastream, and altered it's documentation accordingly.

* a relative path and just entering a filename directly (file/open.nvgt) are actually the same thing, just entering a filename is creating a relative path to a file in the current directory. Fixed that sentence.

* documents a ffew extra things about modes, binary mode doesn't matter in NVGT and + can be used to read and write files in the same object.

* document file::size

* NVGT itself was written in c++ and uses the Angelscript library,, games written in NVGT are written in Angelscript. Replaced the example key/value pair in dictionary docs with data.set("nvgt", "An audiogame engine using AngelScript") just so people won't get slightly confused about the termonology.

* wrote an intro topic for dictionaries.

* clarified that system_node_id is the machine's primary MAC address.

* various improvements to array documentation including an intro topic, extra remarks/clarifications.
@samtupy samtupy merged commit 64b4ae5 into samtupy:main Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants