mirror of
https://github.com/jimeh/rbheap.git
synced 2026-02-19 12:56:46 +00:00
Ensure all exported functions and types have descriptive comments
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
package obj
|
||||
|
||||
// NewEntry returns a new *Entry instance initialized with a *Object of the
|
||||
// given input JSON data.
|
||||
func NewEntry(inputJSON []byte) (*Entry, error) {
|
||||
obj, err := NewObject(inputJSON)
|
||||
if err != nil {
|
||||
@@ -19,6 +21,7 @@ type Entry struct {
|
||||
Index string
|
||||
}
|
||||
|
||||
// Address returns the Address property of the entry's Object.
|
||||
func (s *Entry) Address() string {
|
||||
return s.Object.Address
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user