search

rhaiscript / rhai-url

Provides url access for the Rhai scripting language.
Apache License 2.0
2 stars 0 forks source link

API documentation #2

Closed schungx closed 1 year ago

schungx commented 1 year ago

Would be good to include docs on the API in the README.

You may also consider the method used by many libraries in this org to auto-gen docs based on doc-comments.

schungx commented 1 year ago

BTW, an entry has been added to the Book about rhai-url:

https://rhai.rs/book/lib/rhai-url.html

lucacicada commented 1 year ago

Docs should now be auto-generated, I went ahead and also updated tests and the README.

On a second thought, I think the docs are not quite good enough, nor they do cover common use cases, I would like to keep this issue open to continue working on improving the docs and include some example code.

schungx commented 1 year ago

It seems that the auto-gen docs program does not properly handle property getters and setters, which it should.

I'll fix it in a bit.

schungx commented 1 year ago

@lucacicada I have updated the build script to properly handle property getters and setters. They should now display correctly.

I have also slightly modified the doc-comments style to be consistent with other libraries in the org.

BTW, I see that the no_index feature is never used in the project. It can probably be removed unless you have portion of the API that works on arrays (which doesn't appear to be so).