Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fill missing help texts #795

Open
sinkingsugar opened this issue Sep 22, 2023 · 1 comment
Open

Fill missing help texts #795

sinkingsugar opened this issue Sep 22, 2023 · 1 comment
Assignees

Comments

@sinkingsugar
Copy link
Member

sinkingsugar commented Sep 22, 2023

We have a big lack of embedded documentation, those shards are missing help text:

  • Wasm.Run
  • Unpack
  • Reflect.Name
  • DB.Query
  • RandomBytes
  • RandomInt
  • Physics.CastRay
  • Physics.KinematicBody
  • Physics.StaticBody
  • Physics.Ball
  • ONNX.Activate
  • WS.WriteString
  • Network.Send
  • Network.Client
  • Physics.Cuboid
  • Network.Broadcast
  • Network.Server
  • Inputs.GetContext
  • Inputs.KeyUp
  • Inputs.KeyDown
  • Inputs.MouseUp
  • Inputs.HandleURL
  • Inputs.IsKeyDown
  • Inputs.Mouse
  • Inputs.Size
  • ResizeImage
  • FillAlpha
  • StripAlpha
  • Convolve
  • GetImagePixel
  • Http.Delete
  • Http.Put
  • Network.Peer
  • Http.Post
  • Http.Get
  • String.DecodeURI
  • Http.Response
  • Mutant
  • Evolve
  • FS.LastWriteTime
  • FS.Parent
  • FS.RelativeTo
  • FS.Iterate
  • FS.Join
  • ChaChaPoly.Encrypt
  • Sr25519.Verify
  • FS.SaveFileDialog
  • Ed25519.PublicKey
  • Ed25519.Sign
  • Eth.DecodeCall
  • Hash.XXH-64
  • Hash.Blake2-256
  • Hash.Blake2-128
  • Hash.Sha2-512
  • Hash.Sha3-512
  • Hash.Keccak-512
  • Hash.Keccak-256
  • ECDSA.Seed
  • ECDSA.PublicKey
  • ECDSA.Sign
  • Physics.Impulse
  • FromLEB128
  • Sr25519.Seed
  • ToBase58
  • Time.Epoch
  • Time.EpochMs
  • Time.NowMs
  • Time.Now
  • ToBytes
  • ReadFile
  • Inputs.MousePixelPos
  • WriteFile
  • CaptureLog
  • Inputs.MouseDown
  • Sr25519.Sign
  • DoMany
  • Spawn
  • TryMany
  • Step
  • Detach
  • Do
  • String.Split
  • String.Contains
  • String.Trim
  • Regex.Match
  • Regex.Search
  • Regex.Replace
  • IndexOf
  • PremultiplyAlpha
  • FS.CreateDirectories
  • Process.StackTrace
  • Sr25519.PublicKey
  • Pack
  • Ed25519.Verify
  • Math.Project
  • Math.AxisAngleY
  • Math.Rotation
  • Events.Update
  • Math.MatMul
  • Inputs.MouseDelta
  • IsSeq
  • UnsafeActivate!
  • Assert.Break
  • HexToBytes
  • IsAllNot
  • StringToBytes
  • ChaChaPoly.Decrypt
  • BytesToInts
  • ExpectFloat3
  • FloatsToImage
  • ToInt4
  • IsAudio
  • IsTable
  • Math.Orthographic
  • IsColor
  • WritePNG
  • SleepBlocking!
  • IsImage
  • IsFloat4
  • IsFloat3
  • IsFloat
  • IsInt3
  • Physics.DynamicBody
  • IsInt2
  • Profile
  • ExpectBool
  • ExpectSeq
  • ExpectColorSeq
  • GFX.MainWindow
  • ExpectStringSeq
  • ExpectBytesSeq
  • Math.LookAt
  • ExpectInt8Seq
  • ExpectIntSeq
  • ExpectFloat4Seq
  • ExpectFloatSeq
  • ExpectTable
  • WireRunner
  • ExpectWire
  • FromJson
  • Expand
  • ExpectColor
  • IsAnyLess
  • Math.Decompose
  • ExpectBytes
  • ExpectFloat4
  • ExpectFloat
  • ExpectInt8
  • Http.Server
  • ExpectInt4
  • ExpectInt
  • Shader.LinearizeDepth
  • Expect
  • BitSwap64
  • VarAddr
  • ToHex
  • IsInt4
  • BigInt.IsNot
  • ToString
  • MakeFloat3
  • Inputs.MousePos
  • MakeInt16
  • ToBase64
  • MakeInt2
  • ToFloat3
  • ToFloat2
  • ToInt16
  • ToInt8
  • ToInt3
  • ToInt2
  • FS.Read
  • OnCleanup
  • ExpectAudio
  • Replace
  • Input
  • NaNTo0
  • Events.Emit
  • Fail
  • Return
  • Exit
  • ToJson
  • Pass
  • DB.RawQuery
  • Map
  • ExpectLike
  • IsAllLessEqual
  • MakeFloat2
  • ToFloat
  • FS.Copy
  • IsAllMoreEqual
  • IsAnyMoreEqual
  • IsAllMore
  • IsAnyMore
  • IsInt
  • IsAll
  • FromBytes
  • ToColor
  • IsAny
  • IsLessEqual
  • IsAnyNot
  • GFX.Renderer
  • IsMoreEqual
  • Pause
  • IsNot
  • GFX.Draw
  • Limit
  • ExpectInt2Seq
  • ToFloat4
  • Http.Patch
  • Shards.Help
  • DB.LoadExtension
  • Math.RadiansToDegrees
  • FS.FileDialog
  • Is
  • Snappy.Compress
  • Events.Check
  • UI.GetClipboard
  • DSP.FFT
  • Events.Receive
  • FS.Write
  • IsMore
  • Listen
  • FS.IsDirectory
  • ExpectInt3
  • Network.PeerID
  • BigInt.Is

1 or 2 sentences for each of the 362 records, should not take more than 1 or 2 minutes each.
So it should be done in 2 work days at loose max. Given that some might require research probably 3 days will be needed.

@ccfontes
Copy link
Contributor

ccfontes commented Oct 11, 2023

Extended list:

  • Shards.Enumerate
  • IntsToBytes
  • Shards.Distill
  • Ed25519.seed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants