Skip to content

Commit

Permalink
Small fixes from loading doc site. (#11921)
Browse files Browse the repository at this point in the history
Fixes from loading docs.

(cherry picked from commit 0f88ffd)
  • Loading branch information
jdunkerley committed Dec 19, 2024
1 parent 8b578be commit 7631515
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 42 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ type S3_File
## GROUP Output
ICON folder_add
Within S3 the concept of creating directories has slightly different
meaning than on other filesystems. Text
meaning than on other filesystems.

The `create_directory` method is provided on `S3_File` only for
compatibility - to allow easy switching between file-systems.
Expand Down
2 changes: 2 additions & 0 deletions distribution/lib/Standard/Base/0.0.0-dev/src/Data.enso
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ read_text path=(Missing_Argument.throw "path") (encoding : Encoding = Encoding.d
files from the subdirectories. If set to `False` (the default), only the
immediate children of the listed directory are considered.

? Name Filter Rules

The `name_filter` can contain the following special characters:
- `"?"` - which matches a single filename character (so it will not match a
`"/"`).
Expand Down
48 changes: 24 additions & 24 deletions distribution/lib/Standard/Base/0.0.0-dev/src/Data/Decimal.enso
Original file line number Diff line number Diff line change
Expand Up @@ -1246,41 +1246,41 @@ type Decimal

## GROUP Math
ICON input_number
Construct a `Decimal` from a `Text`, `Integer` or `Float`.
Construct a `Decimal` from a `Text`, `Integer` or `Float`.

Arguments:
- x: The `Text`, `Integer`, or `Float` to construct a `Decimal` from.
- mc: The `Math_Context` to use to specify precision and `Rounding_Mode`.
If a `Math_Context` is used, there is a possibility of a loss of
precision.
Arguments:
- x: The `Text`, `Integer`, or `Float` to construct a `Decimal` from.
- mc: The `Math_Context` to use to specify precision and `Rounding_Mode`.
If a `Math_Context` is used, there is a possibility of a loss of
precision.

? Number Format
? Number Format

The textual format for a Decimal is defined at
https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html#BigDecimal-java.lang.String-.
The textual format for a Decimal is defined at
https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html#BigDecimal-java.lang.String-.

! Error Conditions
! Error Conditions

- If the `Text` argument is incorrectly formatted, a `Number_Parse_Error`
is thrown.
- If the construction of the Decimal results in a loss of precision, a
`Loss_Of_Numeric_Precision` warning is attached. This can only happen
if a `Math_Context` value is explicitly passed.
- If the `Text` argument is incorrectly formatted, a `Number_Parse_Error`
is thrown.
- If the construction of the Decimal results in a loss of precision, a
`Loss_Of_Numeric_Precision` warning is attached. This can only happen
if a `Math_Context` value is explicitly passed.

^ Example
Create a `Decimal` from a `Text`.
^ Example
Create a `Decimal` from a `Text`.

c = dec "12.345"
c = dec "12.345"

^ Example
Create a `Decimal` from an `Integer`.
^ Example
Create a `Decimal` from an `Integer`.

c = dec 12345
c = dec 12345

^ Example
Create a `Decimal` from a `Float`.
^ Example
Create a `Decimal` from a `Float`.

c = dec 12.345
c = dec 12.345
dec : Text | Integer | Float -> Math_Context | Nothing -> Decimal ! Arithmetic_Error | Number_Parse_Error
dec (x : Text | Integer | Float) (mc : Math_Context | Nothing = Nothing) -> Decimal ! Arithmetic_Error | Number_Parse_Error =
handle_java_exception <|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import Standard.Base.Errors.Common.Additional_Warnings
import Standard.Base.Errors.Common.Floating_Point_Equality
import Standard.Base.Errors.Common.Incomparable_Values
import Standard.Base.Errors.Common.Index_Out_Of_Bounds
import Standard.Base.Errors.Common.Type_Error
import Standard.Base.Errors.Common.Missing_Argument
import Standard.Base.Errors.Common.Type_Error
import Standard.Base.Errors.Deprecated.Deprecated
import Standard.Base.Errors.File_Error.File_Error
import Standard.Base.Errors.Illegal_Argument.Illegal_Argument
Expand Down Expand Up @@ -927,7 +927,7 @@ type DB_Table
updated_table = renamed_table.updated_columns (renamed_table.internal_columns + [new_column])
updated_table.as_subquery

## PRIVATE add group column, group id, bucket, tile
## ALIAS add group column, bucket, group id, tile
GROUP Standard.Base.Values
ICON column_add
Adds a new column to the table enumerating groups of rows, assigning each
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,8 @@ replace_columns_with_transformed_columns table selectors transformer error_on_mi
replace_columns_with_columns table columns new_columns


## Takes a table and a list of counts and returns a new table with the rows
## PRIVATE
Takes a table and a list of counts and returns a new table with the rows
duplicated according to the counts.
The vector should have the same number of elements as the number of rows in the table.
duplicate_rows (table : Table) (counts : Vector Integer) -> Table =
Expand Down
28 changes: 14 additions & 14 deletions distribution/lib/Standard/Table/0.0.0-dev/src/Table.enso
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,7 @@ type Table
result = Table.new new_columns
Warning.attach (Deprecated.Warning "Standard.Table.Table.Table" "remove_columns_by_type" "Deprecated: use `remove_columns` with a `By_Type` instead.") result

## ALIAS drop_missing_rows, dropna, remove_blank_rows, remove_empty_rows, remove_missing_rows, filter_empty_rows, drop_empty_rows
## ALIAS drop_empty_rows, drop_missing_rows, dropna, filter_empty_rows, remove_blank_rows, remove_empty_rows, remove_missing_rows
GROUP Standard.Base.Selections
ICON select_column

Expand Down Expand Up @@ -731,7 +731,7 @@ type Table
new_columns = self.columns_helper.select_blank_columns_helper when treat_nans_as_blank
Table.new new_columns

## ALIAS drop_missing_columns, drop_na, select_blank_columns, select_blank_fields, select_missing_columns, select_na, filter_blank_columns
## ALIAS drop_missing_columns, drop_na, filter_blank_columns, select_blank_columns, select_blank_fields, select_missing_columns, select_na
GROUP Standard.Base.Selections
ICON select_column

Expand Down Expand Up @@ -1038,7 +1038,7 @@ type Table
Warning.with_suspended new_names names->
Table.new (self.columns.map c-> c.rename (names.at c.name))

## ALIAS rename, header
## ALIAS header, rename
GROUP Standard.Base.Metadata
ICON table_edit
Returns a new table with the columns renamed based on entries in the
Expand Down Expand Up @@ -1078,7 +1078,7 @@ type Table
problem_builder.attach_problems_before on_problems <|
self.drop (..First 1) . rename_columns new_names_cleaned on_problems=on_problems

## ALIAS group by, summarize, count, count distinct, sum, average, mean, median, percentile, mode, standard deviation, variance, minimum, maximum, first, last, shortest, longest
## ALIAS average, count, count distinct, first, group by, last, longest, maximum, mean, median, minimum, mode, percentile, shortest, standard deviation, sum, summarize, variance
GROUP Standard.Base.Calculations
ICON transform4

Expand Down Expand Up @@ -1856,7 +1856,7 @@ type Table
Warning.attach (Deprecated.Warning "Standard.Table.Table.Table" "auto_value_types" "Deprecated: `auto_value_types` has been replaced by `auto_cast`.") <|
self.auto_cast columns shrink_types error_on_missing_columns on_problems

## ALIAS tokenize, parse
## ALIAS parse, tokenize
GROUP Standard.Base.Conversions
ICON split
Creates a new table by splitting the chosen column of text, by the
Expand Down Expand Up @@ -1887,7 +1887,7 @@ type Table
split_to_columns self column delimiter="," (column_count : Columns_To_Add = ..All_Columns) on_problems:Problem_Behavior=..Report_Warning =
Split_Tokenize.split_to_columns self column delimiter column_count=column_count on_problems

## ALIAS tokenize, parse
## ALIAS parse, tokenize
GROUP Standard.Base.Conversions
ICON split
Creates a new table by splitting the chosen column of text, by the
Expand All @@ -1907,7 +1907,7 @@ type Table
split_to_rows self column delimiter="," =
Split_Tokenize.split_to_rows self column delimiter

## ALIAS split, parse, regex
## ALIAS parse, regex, split
GROUP Standard.Base.Conversions
ICON split

Expand Down Expand Up @@ -1940,7 +1940,7 @@ type Table
tokenize_to_columns self column pattern="." case_sensitivity:Case_Sensitivity=..Sensitive (column_count : Columns_To_Add = ..All_Columns) on_problems:Problem_Behavior=..Report_Warning =
Split_Tokenize.tokenize_to_columns self column pattern case_sensitivity column_count on_problems

## ALIAS split, parse, regex
## ALIAS parse, regex, split
GROUP Standard.Base.Conversions
ICON split

Expand Down Expand Up @@ -1969,7 +1969,7 @@ type Table
tokenize_to_rows self column pattern="." case_sensitivity:Case_Sensitivity=..Sensitive at_least_one_row:Boolean=False =
Split_Tokenize.tokenize_to_rows self column pattern case_sensitivity at_least_one_row

## ALIAS split, tokenize, regex
## ALIAS regex, split, tokenize
GROUP Standard.Base.Conversions
ICON split
Converts a Text column into new columns using a regular expression
Expand Down Expand Up @@ -2325,7 +2325,7 @@ type Table
add_row_number self (name:Text="Row") (from:Integer=0) (step:Integer=1) (group_by:(Vector | Text | Integer | Regex)=[]) (order_by:(Vector | Text)=[]) (on_problems:Problem_Behavior=..Report_Warning) =
Incomparable_Values.handle_errors <| Add_Row_Number.add_row_number self name from step group_by order_by on_problems

## PRIVATE add group column, group id, bucket, tile
## ALIAS add group column, bucket, group id, tile
GROUP Standard.Base.Values
ICON column_add
Adds a new column to the table enumerating groups of rows, assigning each
Expand Down Expand Up @@ -2637,7 +2637,7 @@ type Table
if self.row_count == 0 then Error.throw (Index_Out_Of_Bounds.Error 0 0) else
Row.Value self (self.row_count-1)

## ALIAS merge, xlookup, vlookup, hlookup, lookup
## ALIAS hlookup, lookup, merge, vlookup, xlookup
GROUP Standard.Base.Calculations
ICON join
Joins two tables according to the specified join conditions.
Expand Down Expand Up @@ -2820,7 +2820,7 @@ type Table
self.java_table.crossJoin right.java_table right_prefix java_aggregator
Table.Value new_java_table

## ALIAS join, xlookup, vlookup, hlookup, lookup
## ALIAS hlookup, join, lookup, vlookup, xlookup
GROUP Standard.Base.Calculations
ICON join
Merges this table with a lookup table
Expand Down Expand Up @@ -3430,7 +3430,7 @@ type Table
mask = OrderMask.reverse self.row_count
Table.Value <| self.java_table.applyMask mask

## ALIAS export, save, output, to_file
## ALIAS export, output, save, to_file
GROUP Standard.Base.Output
ICON data_output
This function writes a table from memory into a file.
Expand Down Expand Up @@ -3744,7 +3744,7 @@ type Table
transformer col = col.text_cleanse remove
Table_Helpers.replace_columns_with_transformed_columns self from transformer

## ALIAS cumulative, count, sum, total, minimum, maximum, sum, mean, product, variance, standard deviation
## ALIAS count, cumulative, maximum, mean, minimum, product, standard deviation, sum, sum, total, variance
GROUP Standard.Base.Values
ICON column_add
Adds a new column to the table with a running calculation.
Expand Down

0 comments on commit 7631515

Please sign in to comment.