Skip to content

Document behavior of certain TreeList methods to avoid confusion #1200

Description

@Robotgiggle

Describe the feature

The new TreeList class provides the following access methods:

  • head() gets the first element of the list
  • tail() gets the whole list except the first element
  • last() gets the last element of the list
  • init() gets the whole list except the last element

While apparently standard for these operations, some of these method names (particularly init()) are a little confusing. I would suggest adding javadoc comments explaining what each of them do.

@s5bug

Metadata

Metadata

Assignees

No one assigned

    Labels

    1.21apiAPI-related enhancements/bugs/optimizationsdocumentationenhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    ✅ Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions