Skip to content

Commit

Permalink
Generate API docs for Standard.Base (#12203)
Browse files Browse the repository at this point in the history
* Generate API docs for Standard.Base

* Prettier ignores docs/api directory
  • Loading branch information
Akirathan authored Feb 4, 2025
1 parent 6cbd3d1 commit e38c2b1
Show file tree
Hide file tree
Showing 159 changed files with 3,004 additions and 0 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ distribution/project-manager/THIRD-PARTY
tools
distribution/lib/Standard/*/*/manifest.yaml
distribution/lib/Standard/*/*/polyglot
distribution/lib/Standard/*/*/docs/api
distribution/lib/Standard/*/*/THIRD-PARTY
distribution/docs-js

Expand Down
26 changes: 26 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/docs/api/Any.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Enso Signatures 1.0
## module Standard.Base.Any
- type Any
- != self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- < self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- <= self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- == self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- > self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- >= self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- catch self error_type:Standard.Base.Any.Any= handler:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- catch_primitive self handler:Standard.Base.Any.Any -> Standard.Base.Any.Any
- has_warnings self warning_type:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- if_not_error self ~other:Standard.Base.Any.Any -> Standard.Base.Any.Any
- if_not_nothing self ~action:Standard.Base.Any.Any -> Standard.Base.Any.Any
- if_nothing self ~other:Standard.Base.Any.Any -> Standard.Base.Any.Any
- is_error self -> Standard.Base.Any.Any
- is_nothing self -> Standard.Base.Any.Any
- map_error self ~f:Standard.Base.Any.Any -> Standard.Base.Any.Any
- map_nothing self f:Standard.Base.Any.Any -> Standard.Base.Any.Any
- pretty self -> Standard.Base.Any.Any
- remove_warnings self warning_type:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- throw_on_warning self warning_type:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- to self target_type:Standard.Base.Any.Any -> Standard.Base.Any.Any
- to_display_text self -> Standard.Base.Any.Any
- to_text self -> Standard.Base.Any.Any
- |> self ~function:Standard.Base.Any.Any -> Standard.Base.Any.Any
11 changes: 11 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/docs/api/Data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Enso Signatures 1.0
## module Standard.Base.Data
- type Raw_Response
- get_dropdown_options -> Standard.Base.Any.Any
- download uri:(Standard.Base.Network.URI.URI|Standard.Base.Data.Text.Text)= file:Standard.Base.System.File.Generic.Writable_File.Writable_File replace_existing:Standard.Base.Data.Download.Download_Mode.Download_Mode= method:Standard.Base.Network.HTTP.HTTP_Method.HTTP_Method= headers:(Standard.Base.Data.Vector.Vector Standard.Base.Any.Any)= -> Standard.Base.Any.Any
- fetch uri:(Standard.Base.Network.URI.URI|Standard.Base.Data.Text.Text)= method:Standard.Base.Network.HTTP.HTTP_Method.HTTP_Method= headers:(Standard.Base.Data.Vector.Vector Standard.Base.Any.Any)= format:Standard.Base.Any.Any= cache_policy:Standard.Base.Network.HTTP.Cache_Policy.Cache_Policy= -> Standard.Base.Any.Any
- list directory:Standard.Base.Any.Any= name_filter:Standard.Base.Data.Text.Text= recursive:Standard.Base.Data.Boolean.Boolean= -> Standard.Base.Any.Any
- post uri:(Standard.Base.Network.URI.URI|Standard.Base.Data.Text.Text)= body:Standard.Base.Network.HTTP.Request_Body.Request_Body= method:Standard.Base.Network.HTTP.HTTP_Method.HTTP_Method= headers:(Standard.Base.Data.Vector.Vector Standard.Base.Any.Any)= response_format:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- read path:Standard.Base.Any.Any= format:Standard.Base.Any.Any= on_problems:Standard.Base.Errors.Problem_Behavior.Problem_Behavior= -> Standard.Base.Any.Any
- read_many paths:Standard.Base.Data.Read.Many_Files_List.Many_Files_List= format:Standard.Base.Any.Any= return:Standard.Base.Any.Any= on_problems:Standard.Base.Errors.Problem_Behavior.Problem_Behavior= -> Standard.Base.Any.Any
- read_text path:Standard.Base.Any.Any= encoding:Standard.Base.Data.Text.Encoding.Encoding= on_problems:Standard.Base.Errors.Problem_Behavior.Problem_Behavior= -> Standard.Base.Any.Any
52 changes: 52 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/docs/api/Data/Array.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Array
- type Array
- + self that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- all self condition:(Standard.Base.Data.Filter_Condition.Filter_Condition|Standard.Base.Any.Any) -> Standard.Base.Any.Any
- any self condition:(Standard.Base.Data.Filter_Condition.Filter_Condition|Standard.Base.Any.Any) -> Standard.Base.Any.Any
- at self index:Standard.Base.Data.Numbers.Integer= -> Standard.Base.Any.Any
- contains self elem:Standard.Base.Any.Any -> Standard.Base.Any.Any
- distinct self on:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- drop self range:(Standard.Base.Data.Index_Sub_Range.Index_Sub_Range|Standard.Base.Data.Range.Range|Standard.Base.Data.Numbers.Integer)= -> Standard.Base.Any.Any
- duplicates self on:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- each self f:Standard.Base.Any.Any -> Standard.Base.Any.Any
- each_with_index self f:Standard.Base.Any.Any -> Standard.Base.Any.Any
- filter self filter:(Standard.Base.Data.Filter_Condition.Filter_Condition|Standard.Base.Any.Any) -> Standard.Base.Any.Any
- filter_with_index self predicate:Standard.Base.Any.Any -> Standard.Base.Any.Any
- find self condition:(Standard.Base.Data.Filter_Condition.Filter_Condition|Standard.Base.Any.Any) start:Standard.Base.Data.Numbers.Integer= ~if_missing:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- first self -> Standard.Base.Any.Any
- flat_map self function:Standard.Base.Any.Any on_problems:(Standard.Base.Errors.Problem_Behavior.Problem_Behavior|Standard.Base.Data.Vector.No_Wrap)= -> Standard.Base.Any.Any
- flatten self -> Standard.Base.Any.Any
- fold self init:Standard.Base.Any.Any function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- fold_with_index self init:Standard.Base.Any.Any function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- get self index:Standard.Base.Data.Numbers.Integer= ~if_missing:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- index_of self condition:Standard.Base.Any.Any start:Standard.Base.Data.Numbers.Integer= -> Standard.Base.Any.Any
- insert self at:Standard.Base.Any.Any= item:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- is_empty self -> Standard.Base.Any.Any
- join self separator:Standard.Base.Data.Text.Text= prefix:Standard.Base.Data.Text.Text= suffix:Standard.Base.Data.Text.Text= -> Standard.Base.Any.Any
- last self -> Standard.Base.Any.Any
- last_index_of self condition:Standard.Base.Any.Any start:Standard.Base.Data.Numbers.Integer= -> Standard.Base.Any.Any
- length self -> Standard.Base.Any.Any
- map self function:Standard.Base.Any.Any on_problems:(Standard.Base.Errors.Problem_Behavior.Problem_Behavior|Standard.Base.Data.Vector.No_Wrap)= -> Standard.Base.Any.Any
- map_with_index self function:Standard.Base.Any.Any on_problems:(Standard.Base.Errors.Problem_Behavior.Problem_Behavior|Standard.Base.Data.Vector.No_Wrap)= -> Standard.Base.Any.Any
- not_empty self -> Standard.Base.Any.Any
- pad self n:Standard.Base.Any.Any elem:Standard.Base.Any.Any -> Standard.Base.Any.Any
- partition self condition:(Standard.Base.Data.Filter_Condition.Filter_Condition|Standard.Base.Any.Any) -> Standard.Base.Any.Any
- partition_with_index self predicate:Standard.Base.Any.Any -> Standard.Base.Any.Any
- pretty self -> Standard.Base.Any.Any
- reduce self function:Standard.Base.Any.Any ~if_empty:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- remove self at:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- reverse self -> Standard.Base.Any.Any
- running_fold self init:Standard.Base.Any.Any function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- second self -> Standard.Base.Any.Any
- short_display_text self max_entries:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- slice self start:Standard.Base.Any.Any end:Standard.Base.Any.Any -> Standard.Base.Any.Any
- sort self order:Standard.Base.Any.Any= on:Standard.Base.Any.Any= by:Standard.Base.Any.Any= on_problems:Standard.Base.Errors.Problem_Behavior.Problem_Behavior= -> Standard.Base.Any.Any
- take self range:(Standard.Base.Data.Index_Sub_Range.Index_Sub_Range|Standard.Base.Data.Range.Range|Standard.Base.Data.Numbers.Integer)= -> Standard.Base.Any.Any
- to_array self -> Standard.Base.Any.Any
- to_display_text self -> Standard.Base.Any.Any
- to_list self -> Standard.Base.Any.Any
- to_text self -> Standard.Base.Any.Any
- to_vector self -> Standard.Base.Any.Any
- transpose self -> Standard.Base.Any.Any
- zip self that:Standard.Base.Any.Any function:Standard.Base.Any.Any= on_problems:(Standard.Base.Errors.Problem_Behavior.Problem_Behavior|Standard.Base.Data.Vector.No_Wrap)= -> Standard.Base.Any.Any
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Array_Proxy
- type Array_Proxy
- Value ignore:Standard.Base.Any.Any
- from_proxy_object proxy:Standard.Base.Any.Any -> Standard.Base.Any.Any
- new length:Standard.Base.Any.Any at:Standard.Base.Any.Any -> Standard.Base.Any.Any
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Base_64
- type Base_64
- decode_text encoded_text:Standard.Base.Data.Text.Text encoding:Standard.Base.Data.Text.Encoding.Encoding= -> Standard.Base.Any.Any
- encode_text text:Standard.Base.Data.Text.Text encoding:Standard.Base.Data.Text.Encoding.Encoding= -> Standard.Base.Data.Text.Text
10 changes: 10 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/docs/api/Data/Boolean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Boolean
- type Boolean
- False
- True
- && self ~that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- if_then self ~on_true:Standard.Base.Any.Any -> Standard.Base.Any.Any
- if_then_else self ~on_true:Standard.Base.Any.Any ~on_false:Standard.Base.Any.Any -> Standard.Base.Any.Any
- not self -> Standard.Base.Any.Any
- || self ~that:Standard.Base.Any.Any -> Standard.Base.Any.Any
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Color
- type Color
- HCL hue:Standard.Base.Data.Numbers.Integer chroma:Standard.Base.Data.Numbers.Integer lightness:Standard.Base.Data.Numbers.Integer
62 changes: 62 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/docs/api/Data/Decimal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Decimal
- type Decimal
- From_Float big_decimal:Standard.Base.Data.Decimal.BigDecimal original_value:Standard.Base.Data.Numbers.Float
- Value big_decimal:Standard.Base.Data.Decimal.BigDecimal
- % self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Decimal.Decimal
- * self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Any.Any
- + self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Any.Any
- - self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Any.Any
- / self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Any.Any
- < self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Boolean.Boolean
- <= self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Boolean.Boolean
- > self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Boolean.Boolean
- >= self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Boolean.Boolean
- ^ self exp:Standard.Base.Data.Numbers.Integer -> Standard.Base.Data.Decimal.Decimal
- abs self -> Standard.Base.Data.Decimal.Decimal
- add self that:Standard.Base.Data.Decimal.Decimal math_context:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- ceil self -> Standard.Base.Data.Numbers.Integer
- div self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Decimal.Decimal
- divide self that:Standard.Base.Data.Decimal.Decimal math_context:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- floor self -> Standard.Base.Data.Numbers.Integer
- format self format:Standard.Base.Data.Text.Text= locale:Standard.Base.Data.Locale.Locale= -> Standard.Base.Data.Text.Text
- from_float f:Standard.Base.Data.Numbers.Float mc:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= explicit:Standard.Base.Data.Boolean.Boolean= -> Standard.Base.Any.Any
- from_integer i:Standard.Base.Data.Numbers.Integer mc:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Data.Decimal.Decimal
- from_text s:Standard.Base.Data.Text.Text mc:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- internal_representation self -> (Standard.Base.Data.Vector.Vector Standard.Base.Data.Numbers.Integer)
- max self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Decimal.Decimal
- min self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Decimal.Decimal
- multiply self that:Standard.Base.Data.Decimal.Decimal math_context:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- negate self -> Standard.Base.Data.Decimal.Decimal
- new x:(Standard.Base.Data.Text.Text|Standard.Base.Data.Numbers.Integer|Standard.Base.Data.Numbers.Float) mc:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- parse text:Standard.Base.Data.Text.Text locale:Standard.Base.Data.Locale.Locale= format:Standard.Base.Data.Text.Text= -> Standard.Base.Any.Any
- pow self exp:Standard.Base.Data.Numbers.Integer -> Standard.Base.Data.Decimal.Decimal
- precision self -> Standard.Base.Data.Numbers.Integer
- remainder self that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Decimal.Decimal
- round self decimal_places:Standard.Base.Data.Numbers.Integer= use_bankers:Standard.Base.Data.Boolean.Boolean= -> Standard.Base.Data.Decimal.Decimal
- scale self -> Standard.Base.Data.Numbers.Integer
- set_scale self new_scale:Standard.Base.Data.Numbers.Integer -> Standard.Base.Data.Decimal.Decimal
- signum self -> Standard.Base.Data.Numbers.Integer
- subtract self that:Standard.Base.Data.Decimal.Decimal math_context:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- to_display_text self -> Standard.Base.Data.Text.Text
- to_float self -> Standard.Base.Data.Numbers.Float
- to_integer self -> Standard.Base.Data.Numbers.Integer
- to_text self -> Standard.Base.Data.Text.Text
- to_text_without_scientific_notation self -> Standard.Base.Data.Text.Text
- truncate self -> Standard.Base.Data.Numbers.Integer
- unscaled_value self -> Standard.Base.Data.Numbers.Integer
- attach_loss_of_numeric_precision orig:Standard.Base.Any.Any value:Standard.Base.Any.Any -> Standard.Base.Any.Any
- dec x:(Standard.Base.Data.Text.Text|Standard.Base.Data.Numbers.Integer|Standard.Base.Data.Numbers.Float) mc:(Standard.Base.Data.Numeric.Math_Context.Math_Context|Standard.Base.Nothing.Nothing)= -> Standard.Base.Any.Any
- error_if_from_float left:Standard.Base.Any.Any right:Standard.Base.Any.Any ~action:Standard.Base.Any.Any -> Standard.Base.Any.Any
- from_big_decimal that:Standard.Base.Any.Any -> Standard.Base.Any.Any
- get_big_decimal that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Any.Any
- handle_java_exception ~action:Standard.Base.Any.Any extra_message:Standard.Base.Data.Text.Text= -> Standard.Base.Any.Any
- handle_number_format_exception ~action:Standard.Base.Any.Any -> Standard.Base.Any.Any
- handle_precision_loss original_value:Standard.Base.Any.Any conversion_result:Standard.Base.Data.Decimal.ConversionResult -> Standard.Base.Any.Any
- handle_unsupported_argument_types ~action:Standard.Base.Any.Any -> Standard.Base.Any.Any
- Standard.Base.Data.Ordering.Comparable.from that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Ordering.Comparable
- Standard.Base.Data.Ordering.Comparable.from that:Standard.Base.Data.Numbers.Number -> Standard.Base.Data.Ordering.Comparable
- Standard.Base.Data.Decimal.Decimal.from that:Standard.Base.Data.Text.Text -> Standard.Base.Data.Decimal.Decimal
- Standard.Base.Data.Decimal.Decimal.from that:Standard.Base.Data.Numbers.Integer -> Standard.Base.Data.Decimal.Decimal
- Standard.Base.Data.Decimal.Decimal.from that:Standard.Base.Data.Numbers.Float -> Standard.Base.Data.Decimal.Decimal
- Standard.Base.Data.Numbers.Float.from that:Standard.Base.Data.Decimal.Decimal -> Standard.Base.Data.Numbers.Float
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Dictionary
- type Dictionary key:Standard.Base.Any.Any value:Standard.Base.Any.Any
- at self key:Standard.Base.Any.Any -> Standard.Base.Any.Any
- contains_key self key:Standard.Base.Any.Any -> Standard.Base.Any.Any
- each self function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- each_with_key self function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- empty -> Standard.Base.Any.Any
- fold self init:Standard.Base.Any.Any function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- fold_with_key self init:Standard.Base.Any.Any function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- from_keys_and_values keys:Standard.Base.Data.Vector.Vector values:Standard.Base.Data.Vector.Vector error_on_duplicates:Standard.Base.Data.Boolean.Boolean= -> Standard.Base.Any.Any
- from_vector vec:Standard.Base.Any.Any error_on_duplicates:Standard.Base.Data.Boolean.Boolean= -> Standard.Base.Any.Any
- get self key:Standard.Base.Any.Any ~if_missing:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- get_builtin self key:Standard.Base.Any.Any ~if_missing:Standard.Base.Any.Any -> Standard.Base.Any.Any
- insert self key:Standard.Base.Any.Any= value:Standard.Base.Any.Any= no_warning:Standard.Base.Data.Boolean.Boolean= -> Standard.Base.Any.Any
- is_empty self -> Standard.Base.Any.Any
- keys self -> Standard.Base.Any.Any
- length self -> Standard.Base.Any.Any
- map self function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- map_keys self function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- map_with_key self function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- not_empty self -> Standard.Base.Any.Any
- remove self key:Standard.Base.Any.Any= -> Standard.Base.Any.Any
- singleton key:Standard.Base.Any.Any value:Standard.Base.Any.Any -> Standard.Base.Any.Any
- size self -> Standard.Base.Any.Any
- to_text self -> Standard.Base.Any.Any
- to_vector self -> Standard.Base.Any.Any
- transform self function:Standard.Base.Any.Any -> Standard.Base.Any.Any
- values self -> Standard.Base.Any.Any
- key_value_widget -> Standard.Base.Metadata.Widget
- key_widget dict:Standard.Base.Data.Dictionary.Dictionary -> Standard.Base.Metadata.Widget
- Standard.Base.Data.Dictionary.Dictionary.from that:Standard.Base.Data.Vector.Vector -> Standard.Base.Data.Dictionary.Dictionary
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Enso Signatures 1.0
## module Standard.Base.Data.Download.Download_Mode
- type Download_Mode
- Always
- If_Not_Exists
- If_Older_Than age:Standard.Base.Data.Time.Duration.Duration
- should_download self file:Standard.Base.System.File.Generic.Writable_File.Writable_File -> Standard.Base.Data.Boolean.Boolean
Loading

0 comments on commit e38c2b1

Please sign in to comment.