README needs a little fix
Closed this issue · 3 comments
In the image below, it's described that running make:baum {model_name}
will generate both a Model and a Migration:

However, in the latest version, 3.1.0, only the Model is generated, as you can see below:
Due to the great generosity of the person who created the package, there's an example of a migration to create the table right below in the documentation. Nevertheless, just as it caused confusion for me, the statement about the creation of both files might confuse other users!
Thank you very much!
@lucasborges24 would you like "make:baum {model_name}" to generate both a Model and a Migration? do you think that is the most practical usage?
I think it would be best to keep them separate and update the readme as you have suggested.
Thanks for catching this!
I personally believe the current way is preferable! Updating the Readme was indeed my suggestion :)
Additionally, I was going through the documentation yesterday while implementing some code, and I stumbled upon another discrepancy in the readme:
In the section where you detail the ancestors/descendant methods, there's a slight mix-up with the sibling method's description:
I believe the more accurate descriptions would be:
getSiblingsAndSelf()
: Retrieve all siblings of the node, including the node itself.
getSiblings()
: Return all siblings of the node, excluding the node itself.
By the way, I'm genuinely excited about this package! While working with it, I realized there was a particular method I couldn't find . I'd love to take the initiative and implement it in a PR. I believe it could be a valuable addition to the package.
Hope this helps and thank you for the continuous work on this package!
@lucasborges24 I agree with you I prefer the current way. I will double check it works like that then get the wording updated. As for the other wording changes I agree as the wording you proposed fits the verbage of the other functions better and its clearer.
That being said feel free to open an issue for a new method and make a fork to work on it.
I will most likely get these wording changes done in the next 2 weeks.