doc: reformat standard library documentation

This commit is contained in:
2024-12-14 21:07:20 +00:00
parent a167dd2af5
commit 5a00f271d8

View File

@@ -1,8 +1,21 @@
vim: tabstop=2 shiftwidth=2 expandtab
+------------------------------------------------------------------------------+
| The Ivy Programming Language |
| ........................................ |
| Standard Library Specification |
+------------------------------------------------------------------------------+
*** PACKAGES ******************************************************************
version: 1.0
1 Introduction
==============
This document provides an overview of the packages, classes, and objects that
are included as part of the Ivy standard library
3 std.lang
==========
## std.lang #####
This package contains all of the "built-in" classes, such as String,
Package, etc.
@@ -10,19 +23,11 @@ vim: tabstop=2 shiftwidth=2 expandtab
there is no need to include a `use std.lang` statement.
## std.io #####
This package includes classes for performing IO operations, including
reading/writing to the terminals, files, etc.
3.1 Object
----------
This package also includes the cin, cout, and cerr objects that point
to standard in, standard out, and standard error respectively.
Messages:
*** CLASSES *******************************************************************
//// std.lang ////
## Object #####
-is:
-implements:
-respondsTo:
@@ -30,16 +35,23 @@ vim: tabstop=2 shiftwidth=2 expandtab
-sendMsg(selector:args:)
-toString
## Int #####
3.2 Int
-------
Messages:
+parse:
-to:
-to:step:
-to:step:do:
## Enum #####
**
## String #####
3.3 String
----------
Messages:
-size
-uppercase
-lowercase
@@ -49,11 +61,21 @@ vim: tabstop=2 shiftwidth=2 expandtab
-contains:
-iterator
## Bool #####
3.4 Bool
--------
Messages:
-if:
-if:else:
## Package #####
3.5 Package
-----------
Messages:
-size
-exists:
-put:at:
@@ -63,14 +85,24 @@ vim: tabstop=2 shiftwidth=2 expandtab
-select:collect:
-iterator
## Iterator #####
3.6 Iterator
------------
Messages:
-value
-moveNext
-select:
-select:collect:
-iterator
## Lambda #####
3.7 Lambda
----------
Messages:
-argCount
-call
-call:
@@ -82,10 +114,33 @@ vim: tabstop=2 shiftwidth=2 expandtab
-if:
-unless:
## Selector #####
3.8 Selector
------------
Messages:
+parse:
## Error #####
3.9 Error
---------
Messages:
-msg
-data
-withMsg:andData:
4 std.io
========
This package includes classes for performing IO operations, including
reading/writing to the terminals, files, etc.
This package also includes the cin, cout, and cerr objects that point
to standard in, standard out, and standard error respectively.
vim: shiftwidth=3 expandtab