Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Typo in function name message vs export: supressNotices vs. suppressNotices #845

Closed
sid-the-sloth opened this issue Dec 1, 2024 · 2 comments
Closed

Typo in function name message vs export: supressNotices vs. suppressNotices #845

sid-the-sloth opened this issue Dec 1, 2024 · 2 comments
Labels
bug Something isn't working released

Comments

@sid-the-sloth
Copy link

sid-the-sloth commented Dec 1, 2024 •
edited
Loading

bad message about function supressNotices

Describe the bug

Trying to suppress notices, according to the output to console:

Please consider completing the survey at https://bit.ly/yahoo-finance-api-feedback if you haven't already; for more info see https://github.com/gadicc/node-yahoo-finance2/issues/764#issuecomment-2056623851.  This will only be shown once, but you can suppress this message in future with `yahooFinance.supressNotices(['yahooSurvey'])`.

Please note the spelling in above message: yahooFinance.supressNotices(['yahooSurvey']).

If you try to use that, nodejs will show an error, of course:

TypeError: yahooFinance.supressNotices is not a function

Looking through the source file node-yahoo-finance2/src/lib/notices.ts in this repo, the code shows a different name for the function name (proper English spelling: "suppress"):

export function suppressNotices(noticeIds: (keyof typeof notices)[]) {...}

Please fix the spelling of the message to match the exported function name.
@sid-the-sloth sid-the-sloth added the bug Something isn't working label Dec 1, 2024
@sid-the-sloth sid-the-sloth changed the title Typo in function name: Typo in function name message vs export: supressNotices vs. suppressNotices Dec 1, 2024
@gadicc gadicc closed this as completed in 0e47049 Dec 21, 2024
@gadicc
Copy link
Owner

gadicc commented Dec 21, 2024 •
edited
Loading

Thanks so much, @sid-the-sloth! This will be in the next release, and there will be an automated message here once it's published. Thanks for the detailed report 🙏

gadicc pushed a commit that referenced this issue Dec 21, 2024
@semantic-release-bot
chore(release): 2.13.3 [skip ci]
c69f9bc 
## [2.13.3](v2.13.2...v2.13.3) (2024-12-21)

### Bug Fixes

* **chart:** validate includePrePost:false, interval:1m (fixes [#812](#812)) ([5ca811d](5ca811d))
* **fetchDevel:** fix application/json detection ([cc0390a](cc0390a))
* **fetchDevel:** use std Headers methods in contentObj ([#826](#826)) ([46273db](46273db))
* **notices:** fix typo in log: s/supress/suppress/ (fixes [#845](#845)) ([0e47049](0e47049))

### Reverts

* Revert "chore(tests): temporarily disable getCrumb tests on CI" ([6f48387](6f48387))
* Revert "chore(tests): different approach for weird CI getCrumb test issue" ([d595714](d595714))
@gadicc
Copy link
Owner

gadicc commented Dec 21, 2024

🎉 This issue has been resolved in version 2.13.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working released
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gadicc @sid-the-sloth