fix: remove empty entries for hilbish module, add descriptions

docs-refactor
TorchedSammy 2022-12-02 17:02:13 -04:00
parent e258f9c8ba
commit 9df0c4c0df
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
3 changed files with 7 additions and 116 deletions

6
api.go
View File

@ -1,6 +1,6 @@
// Here is the core api for the hilbi shell itself // the core Hilbish API
// Basically, stuff about the shell itself and other functions // The Hilbish module includes the core API, containing
// go here. // interfaces and functions which directly relate to shell functionality.
package main package main
import ( import (

View File

@ -116,6 +116,7 @@ func main() {
} }
for _, t := range p.Types { for _, t := range p.Types {
for _, m := range t.Methods { for _, m := range t.Methods {
if !strings.HasPrefix(t.Name, "hl") && l == "main" { continue }
if !strings.HasPrefix(m.Name, prefix[l]) || m.Name == "Loader" { continue } if !strings.HasPrefix(m.Name, prefix[l]) || m.Name == "Loader" { continue }
parts := strings.Split(strings.TrimSpace(m.Doc), "\n") parts := strings.Split(strings.TrimSpace(m.Doc), "\n")
funcsig := parts[0] funcsig := parts[0]

View File

@ -1,12 +1,12 @@
--- ---
name: Module hilbish name: Module hilbish
description: Here is the core api for the hilbi shell itself description: the core Hilbish API
layout: apidoc layout: apidoc
--- ---
## Introduction ## Introduction
Basically, stuff about the shell itself and other functions The Hilbish module includes the core API, containing
go here. interfaces and functions which directly relate to shell functionality.
## Functions ## Functions
### alias(cmd, orig) ### alias(cmd, orig)
@ -89,113 +89,3 @@ Returns a `timer` object (see `doc timers`).
### which(name) ### which(name)
Checks if `name` is a valid command Checks if `name` is a valid command
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###
###