Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

Commit

Permalink
v1.0.2 - linkify type and func refs; update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
JesseCoretta committed Nov 5, 2023
1 parent dd8e504 commit dff3f1f
Show file tree
Hide file tree
Showing 21 changed files with 287 additions and 393 deletions.
14 changes: 7 additions & 7 deletions attr.go
Original file line number Diff line number Diff line change
Expand Up @@ -615,21 +615,21 @@ func (r AttributeTypes) setQuoteStyle(style int) AttributeTypes {
}

/*
IsZero wraps go-stackage's Stack.IsZero method.
IsZero wraps the [stackage.Stack.IsZero] method.
*/
func (r AttributeTypes) IsZero() bool {
return r.cast().IsZero()
}

/*
Len wraps go-stackage's Stack.Len method.
Len wraps the [stackage.Stack.Len] method.
*/
func (r AttributeTypes) Len() int {
return r.cast().Len()
}

/*
Index wraps go-stackage's Stack.Index method. Note that the
Index wraps the [stackage.Stack.Index] method. Note that the
Boolean OK value returned by go-stackage by default will be
shadowed and not obtainable by the caller.
*/
Expand All @@ -646,14 +646,14 @@ func (r AttributeTypes) Index(idx int) (x AttributeType) {
String is a stringer method that returns the string
representation of the receiver instance.
This method wraps go-stackage's Stack.String method.
This method wraps the [stackage.Stack.String] method.
*/
func (r AttributeTypes) String() string {
return r.cast().String()
}

/*
Kind wraps go-stackage's Stack.Category method for the
Kind wraps the [stackage.Stack.Category] method for the
purpose of identifying the context of the receiver instance.
*/
func (r AttributeTypes) Kind() string {
Expand Down Expand Up @@ -696,7 +696,7 @@ func (r AttributeTypes) transfer(dest AttributeTypes) {
}

/*
Pop wraps go-stackage's Stack.Pop method.
Pop wraps the [stackage.Stack.Pop] method.
*/
func (r AttributeTypes) Pop() (x AttributeType) {
z, _ := r.cast().Pop()
Expand All @@ -708,7 +708,7 @@ func (r AttributeTypes) Pop() (x AttributeType) {
}

/*
Push wraps go-stackage's Stack.Push method. Valid input types are string and [AttributeType]. In the case of a string value, it is automatically cast as an instance of [AttributeType], so long as the raw string is of a non-zero length.
Push wraps the [stackage.Stack.Push] method. Valid input types are string and [AttributeType]. In the case of a string value, it is automatically cast as an instance of [AttributeType], so long as the raw string is of a non-zero length.
*/
func (r AttributeTypes) Push(x ...any) AttributeTypes {
_r := r.cast()
Expand Down
9 changes: 3 additions & 6 deletions attr_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func ExampleAttributeType_Compare() {

/*
This example demonstrates the use of the useless [Keyword] method, as [AttributeType]
instances do not have any knowledge of [Keyword]s at this time.
instances do not have any knowledge of [Keyword] instances at this time.
*/
func ExampleAttributeType_Keyword() {
fmt.Printf("%v", AT(`owner`).Keyword())
Expand Down Expand Up @@ -83,8 +83,7 @@ func ExampleAttributeType_Valid() {
}

/*
This example demonstrates how a caller can determine the number of comparison
operator methods are available for use by the receiver instance.
This example demonstrates how a caller can determine the number of [ComparisonOperator]-related methods are available for use by the receiver instance.
*/
func ExampleAttributeType_TRM() {
var at AttributeType
Expand Down Expand Up @@ -309,9 +308,7 @@ func ExampleAttributeTypes_String() {
}

/*
This example demonstrates the use of the receiver's TRM
method in order to determine available [ComparisonOperator]
driven methods available in this context.
This example demonstrates the use of the receiver's TRM method in order to determine available [ComparisonOperator]-related methods available in this context.
*/
func ExampleAttributeTypes_TRM_targetAttributes() {
attrs := TAs(
Expand Down
Loading

0 comments on commit dff3f1f

Please sign in to comment.