ULX and ULib Documentation

[LuaTenshi]

I have noticed that the http://ulyssesmod.net/docs/files/ULib_readme-txt.html documentation is not really extensive or easy to use, it seems like more then a few commands are missing from it and to be honest I think it needs a total revamp.

I am willing to help if you wish me to. ( I would be honored if I could help with it , as my title on this forum suggests... )

---Below is the help and support part---

Also changing the subject slightly...
What is the command used to check what groups inherit from a group?
Is there a way to find the group that is currently the highest rank?

[Megiddo]

Throw us an example of how you propose to change the documentation.

To check what group inherits from a group, use ucl.groupInheritsFrom. To find the group(s) that are highest rank (there can be multiple since you can have multiple trees), use ucl.getInheritanceTree. Both of these functions are decently documented.

[LuaTenshi]

Throw us an example of how you propose to change the documentation.

To check what group inherits from a group, use ucl.groupInheritsFrom. To find the group(s) that are highest rank (there can be multiple since you can have multiple trees), use ucl.getInheritanceTree. Both of these functions are decently documented.

Well lets say you are not sure exactly what command your looking for but you know what you want it to do for example the stuff I was talking about above searching ucl brings up nothing, when you would expect it to return some thing similar to this... http://wiki.garrysmod.com/page/Category:Panel

Basically I want to make the documentation more friendly for the average user, so that its easy to find things visually as well as add some ULX functions like ulx.jail and what not.

[JamminR]

Hellfox, we purposely keep ULib separate of ULX.
Though we'd hoped many more developers would write modules for ULib not just ULX, I could see how one would try to intertwine them.

As for your searching for UCL issue, not sure why you have problem.
I do notice if you select 'ucl' instead of UCL after typing the search, it comes up with less/different.
Though the search isn't case sensitive, the documentation apparently is.

[Megiddo]

HeLLFox, what I'm asking for is a working example of how would setup the documentation. EG, we're using Natural Docs right now. If you think using a wiki would be better, create one and document a few functions to show us how you would envision it working.

Though as a note, I think Garry's documentation started out awful and has progressively gotten worse. He did no documentation himself and instead relied on the community to document his work... which is just an awful idea from the get-go. But, when he tried to be more regimented about documenting things himself, it turned out even worse. Or at least, I always find myself referring to the old wiki archives because they tend to be more accurate. Also, we have used a wiki for documenting in the past with very little success ourselves, but that was a very, very long time ago so I'm willing to give it another shot.

On UCL in particular, Natural Docs isn't working quite like you'd expect it to because of ND's limitations with Lua, but if you really needed to see all UCL functions you can do so by looking through the three UCL files (server, shared, client). It's not perfect, but our current documentation system beats out Garry's quite handily.