neo4jrb / activegraph

An active model wrapper for the Neo4j Graph Database for Ruby.
http://neo4jrb.io
MIT License
1.4k stars 276 forks source link

has_many method documentation #1521

Open iehdk opened 5 years ago

iehdk commented 5 years ago

So the has_many explanation @ https://neo4jrb.readthedocs.io/en/9.2.x/ActiveRel.html could be better, IMHO. Take the example:

class Student
  include Neo4j::ActiveNode
  has_many :out, :lessons, rel_class: :EnrolledIn
end

What is :out ? What is :lessons? What does rel_class accept?

jorroll commented 5 years ago

Starting in the ActiveNode association's section might be easier: https://neo4jrb.readthedocs.io/en/9.2.x/ActiveNode.html#associations.

I've never thought about it before, but the docs might be best read in order.

Also, FYI

When you figure things out, if you have an idea for how to improve the docs, a PR would be welcomed.