elliotchance / elliotchance/orderedmap

doc suggestion: note up front it is not sorted by key, but insertion order.

Open
#58 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
1k
Forks
77
PR merge metrics
No merged PRs in 30d

Description

Just 0.02 of feedback --

When I read "ordered", I thought this package provided for range queries on sorted keys.

The issue about "map is not sorted" set me straight, but there is nothing in the readme to indicate this subtlety.

I only lost ~ 30 minutes to this mis-conception, but I would have appreciated it if the README was more up front about what the overloaded term "ordered" is indicating here. Your usage is not what first comes to mind, though I've certainly implemented the same for some needs.

edited: Thanks! nice package btw.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.