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.

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

Document - missing return type #223

Open
sacru2red opened this issue May 29, 2024 · 6 comments
Open

Document - missing return type #223

sacru2red opened this issue May 29, 2024 · 6 comments

Comments

@sacru2red
Copy link

https://date-fns.org/v3.6.0/docs/isDate

current: If you see this, ping me.
expected: boolean

image

@kossnocorp

@zapha
Copy link

zapha commented May 29, 2024

I'd like to work on this. Can I work on this?

@henrique2003
Copy link

Hello, I would like to start contributing to this project, but I confess that I am lost as to how I can begin to understand how the contribution process works.
Can someone help me.

@WikiRik
Copy link

WikiRik commented Jun 4, 2024

The current return type in the code is value is Date, that could become a boolean to fix the docs. You'll need to update the following line;
https://github.com/date-fns/date-fns/blob/c053552651f5354de6bd10cc20ea17a2cc9f7511/src/isDate/index.ts#L33

Further information about contributing can be found in CONTRIBUTING.md

@zapha
Copy link

zapha commented Jun 4, 2024

Sure. I will be working on it. Thanks @WikiRik .

@zapha
Copy link

zapha commented Jun 6, 2024

I was looking at the code yesterday and tried to generate the document. It returns value is Date as it is in the code. Please see the screen shot.
Screenshot 2024-06-06 at 10 22 02 PM
So, I wonder if we want to provide return value as boolean or value is Date.
Anyone can confirm this? or Open discussion?

@WikiRik
Copy link

WikiRik commented Jun 6, 2024

I'm fine with keeping with value is Date, but then we'll need to update how the site renders that.

@kossnocorp kossnocorp transferred this issue from date-fns/date-fns Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants