boilerplate
boilerplate copied to clipboard
Change listSlice to sliceList to align with docs
Description
No open issue for this and the fix was obvious enough. I have a feeling I'm the only one that's used this alias so far.
In the documentation this function alias is referred to as sliceList
. When trying to use it I kept getting
function "sliceList" not defined
After going back and forth in the docs, double-checking my typing, copy-pasting from the docs, updating to the latest release, I eventually decided to dive into the code. Thankfully it was pretty obvious what went wrong here. I even went back to my template to verify that listSlice
worked and it did! Hooray! Of course next release I'll need to change my listSlice
to sliceList
, but at least the code and docs will be aligned now :)
If you guys decide to go the other way and change the docs instead, or keep both listSlice
and sliceList
as aliases, feel free to close this PR and do the changes yourself or push commits to my branch. I've been very happy with the boilerplate so far, thanks so much for making and releasing it!
TODOs
Read the Gruntwork contribution guidelines.
- [x] Update the docs. code is now aligned with the docs
- [ ] Run the relevant tests successfully, including pre-commit checks.
- [x] Include release notes. If this PR is backward incompatible, include a migration guide.
Release Notes (draft)
Fixed the alias to the Spring slice
function. It was documented as sliceList
but was implemented as listSlice
.
Migration Guide
Replace all usages of listSlice
with sliceList
instead.