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

add troubleshooting FAQ #11

Open
davewhiteland opened this issue Jul 25, 2019 · 1 comment
Open

add troubleshooting FAQ #11

davewhiteland opened this issue Jul 25, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@davewhiteland
Copy link
Collaborator

Most obvious problem is JSON parsing errors, but it would be helpful to acknowledge the dependency chain too.

I've been caught out by ring_radius being smaller than radius so not showing up, for example.

@davewhiteland davewhiteland added the documentation Improvements or additions to documentation label Jul 25, 2019
@davewhiteland
Copy link
Collaborator Author

davewhiteland commented Aug 1, 2019

  • don't iterate over the graph.travellers array if you're calling traveller.destroy() because it splices the array
  • be aware that you can inadvertently specify identical keys in the JSON config, thereby silently overwriting previous ones (e.g., two vertices definitions)
  • pulse will never work until has_pulse is true
  • if you think journey_lifespan is set to 1 but it's really 0, you can have a huge memory leak (whoops)
  • not specifying some of the named functions is a fatal error during setup/init, but others aren't (e.g., travellers' on_arrival missing is a run-time error) — need to look into this or have a policy on it
  • creating a vertex with a non-unique id is not rejected as error but if you do that behaviour is undefined

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant