Tweak some docstrings - Githubissues

sogaiu commented 3 weeks ago

This PR tweaks a couple of docstrings for some dynamic variables.

sogaiu commented 3 weeks ago

Ah sorry, I see there might be some other docstrings that might improve with a bit of adjustment.

I'll list some other things I've noticed below.

bundle/install mentions bundle-name but it's not apparent how this gets passed in via arguments (I think it's via config). Also, there is no mention of path or config in the docstring prose.
eval and eval-string have docstrings that don't mention the new ability to pass env. May be the docstrings can be modified to account for this.
ev/with-wlock's docstring says "read access", but may be this should be "write access"?
import doesn't mention the newly added :only option. :only is mentioned in merge-module's docstring though so may be those can be pointed at or the content copy-modified appropriately.
merge-module mentions "If an array only..." -- looks like this can be a tuple as well and perhaps that's what folks would want to use ordinarily?

bakpakin commented 3 weeks ago

All reasonable changes, these are bad enough I should probably make a patch release. Thanks @sogaiu

janet-lang / janet