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? #95

Open
nurbles opened this issue Mar 15, 2024 · 0 comments
Open

Documentation? #95

nurbles opened this issue Mar 15, 2024 · 0 comments

Comments

@nurbles
Copy link

nurbles commented Mar 15, 2024

I have been trying to find documentation for a BASIC language on line that at least slightly matches MY-BASIC, on the assumption that MY-BASIC's built-in functions are based on some earlier BASIC implementation. Unfortunately, I have been unsuccessful. This means that the collection library functions are pretty much undocumented, other than having their names and fundamental function in a table. Oh, and a couple of examples in the wiki that doesn't really help to actually document how the functions are used.

For example, the DICT function has three examples that provide all available documentation:

d = dict(1, “one”, 2, “two”)
d = dict()
d = dict(1, 2, 3, 4, 5, 6)

I would guess that there's no limit (that I would reach) for the number of parameters to DICT. However, the first example seems to show the parameters as index/value pairs, while the third seems to be just creating something like a single dimension array of 6 integers. It is also unclear whether the parameters may be any type or (INT,any) pairs or some other rule. I was hoping for (STRING,any) pairs so that I could look up elements by STRING, but even if that is possible, there is no documentation on how to create such a thing in a user-defined function (C, called from MY-BASIC) to return to the BASIC caller. The function and parameter names/types does not really count as documentation, sorry.

If there is a language reference where all of the functions implemented in MY-BASIC were documented, could you please provide a link to the document (or web site) where we may read it?

If you invented these functions yourself, then they really, really need to be adequately documented. Please?

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

No branches or pull requests

1 participant