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

Some feedback on documentation #841

Open
1 of 6 tasks
st0012 opened this issue Apr 16, 2020 · 0 comments
Open
1 of 6 tasks

Some feedback on documentation #841

st0012 opened this issue Apr 16, 2020 · 0 comments
Assignees

Comments

@st0012
Copy link
Member

st0012 commented Apr 16, 2020

These are the feedback from @yawniek on slack

  • the vm.New vm.New and v.ExecInstructions methods would profit from some minimal documentation, especially what all the "paths" actually mean. some of them seemed semi obvious..
  • same for RegisterExternalClass ExternalClass and vm.Method albeit those are relatively clear
  • how can i load a class into toplevel so i dont need a require in the goby code?
  • how can i load a method into the toplevel space / current vm context?
  • in general a more clean example of whats done in db/plugin on how to interfer with go structs and their method would be super helpful, especially when it comes to handling and converting numbers,maps and slices.
  • also explaining the details of the receiver vm.Object, sourceLine int, t *vm.Thread, args []vm.Object) vm.Object signature and how to efficiently work with it would be helpful
@st0012 st0012 changed the title Some feedbacks on documentation Some feedback on documentation Apr 16, 2020
@st0012 st0012 self-assigned this Apr 16, 2020
@st0012 st0012 added this to the version 0.1.13 milestone Apr 16, 2020
@st0012 st0012 modified the milestones: version 0.1.13, version 0.1.14 Apr 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant