Skript: Docs missing hooks

Created on 2 Aug 2018  路  9Comments  路  Source: SkriptLang/Skript

So I noticed that certain things are missing from the docs.
Such as prefix/suffix, regions, GriefPrevention, etc
I found these because of the skunity docs, but didn't see them anywhere on the bensku docs.
For fun, I looked and they are on the Njol docs.
I then looked at the code on this site, and noticed things such as "prefix/suffix" are in a different section called hooks, rather than effects/events/expressions. and Im starting to think everything in the hooks category is missing from the Bensku docs?!?!?
Im not sure if this was done on purpose or mistake, but is it possible to add this stuff back into the docs?

documentation

Most helpful comment

another solution might be registering the syntax regardless of plugins if skript is in debug mode. They won't work, but that doesn't matter to the doc gen.

All 9 comments

Hooks cannot have documentation generated for them if they rely on plugins that are not present on server which generates the documentation. I'm honestly not sure how hard changing that would be.

Or we could manually download the plugins before generating the docs

Ah dur... that makes sense! I will make sure to add those plugins for when i create my own docs. As nico said its probably a good idea to do that, since the bensku docs website is missing those few things. I mean IM smart enough to find them, but some others may not know where to look for those syntaxes.

_By the way don't use skUnity especially for Skript docs, it is outdated. https://skripthub.net/docs/?addon=Skript_

I was just stating that because I saw them on there. I use skunity docs vs skript hub because they have more addons.
I鈥檝e already regenerated my new skript docs and put them on my website for reference and as suggested I made sure to add the hook plugins to ensure I get a full doc (including vault, pex, economy, GriefPrevention)

Also @bensku I read your reply a few times and I think I may have worded my post wrong. I meant to say your website with the docs is missing the hook items. I myself realize what you mean about making my own docs and requiring those plugins, which I have done for my docs, so thank you for that info. But I wasn't meaning there was a problem with the doc gen, but specially referring to your website that those parts of the docs were missing.

I understood that you meant the website. Currently, however, we don't have any special environment for generating docs: it is my development server. Running plugins other is always a bit risky when you're trying to find bugs in Skript.

But in future I'll try to remember to grab the hooked plugins when generating docs. That should do as a temporary solution.

Awesome thank you
I made a copy of the docs for my website as a temp one and got them all working, so personally I'm not terribly concerned ... was more for other people who use the docs website, and potentially dont know where else to look for those syntaxes.

Thanks again

another solution might be registering the syntax regardless of plugins if skript is in debug mode. They won't work, but that doesn't matter to the doc gen.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

cyanide43 picture cyanide43  路  4Comments

Anarchick picture Anarchick  路  3Comments

Snow-Pyon picture Snow-Pyon  路  4Comments

Eryk1983S picture Eryk1983S  路  3Comments

wohahobg picture wohahobg  路  3Comments