View Single Post
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: Fish Tank
Old 03-12-2020 , 11:06   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #21

Quote:
Originally Posted by kadet.89 View Post
Would be nice to have comments like in the old API:

https://sm.alliedmods.net/api/index....ad=show&id=44&
https://sm.alliedmods.net/api/index....ad=show&id=87&
https://sm.alliedmods.net/api/index....ad=show&id=69&
https://sm.alliedmods.net/api/index....d=show&id=829&

We could add examples to just copy and past them to own plugins or describe some features and nuances.
Or automatically generate links to plugins where a specific function is used, something of that kind:

Need an example?, here are all plugins where "Teleport" function is used: https://www.sourcemod.net/plugins.ph...eport&search=1
I don't think that's viable ATM, and here's my reasoning.

This documentation is designed to be entirely client-side, with networking being required only when loading to cache parsed documentation. Adding comments would require a server-side data store and frequent comments fetching.

The second thing would be moderation, with login, an account is preferably required, which requires secure server-side data store. And determining which comment is appropriate requires more labor work.

Going forward, I believe any necessary useful info should be included in the documentation body and not in comments so that it can be viewed even if they don't use this documentation site.
__________________

Last edited by RumbleFrog; 03-12-2020 at 11:08.
RumbleFrog is offline