feat: create a script to detect missing functions

[Odonno]

Create a script to detect missing functions in the documentation.

• Read the list of functions from the source code of the surrealdb repository...
• ...and the currently documented functions in this repository
• Check and output the differences

Current output:

Note that it can also detect documented functions that no longer exist.

TODO list:

• use sync & async Rust fn from source code instead of the fuzz dictionary (to be more reliable)
• write docs for the currently missing functions (fixes Documentation: Missing functions in documentation page for type function module #834)
• play this script in the CI (with exit code) to fail if missing function found

[netlify]

👷 Deploy request for surrealdb-docs pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	3d45fca

[Dhghomon]

This is pretty helpful! Just about done a PR that adds many of them. They are mostly of this type:

• Already documented: crypto::blake3 and math::pow (looks like a false positive)
• Path exists but not implemented: all the string:: functions except smithwaterman, mahalanobis, spearman.
• Aliases: record::table(), string::similarity::smithwaterman() (same code as ::fuzzy), array::every, array::includes, array::index_of, array::some. Going to skip them on this PR I think as we should probably think of a good way to display all the aliases in a unified way first.
• type::geometry(): this is a funny one as it only takes an input that is already a geometry. I'm thinking holding off on this one until it becomes more useful (like taking an object).

The rest of them I added. Shout out to search::analyze() which is exactly the function I wanted! I had no idea it was already there.

[Odonno]

Yes, small mistakes for math::pow and crypto::blake3.

I suppose I need to exclude "not yet implemented functions" but I want that to be easily editable. What do you think of an arg (env variable) directly in the yml file of the GitHub Action @Dhghomon ?

The currently remaining functions:

[Odonno]

Done. Only aliases remains and the new function geo::is::valid. See: