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

TypeDoc displays a superfluous type on number constants implementation #2721

Merged
merged 5 commits into from
Oct 3, 2024

Conversation

Corso02
Copy link
Contributor

@Corso02 Corso02 commented Sep 29, 2024

This PR is implementing the enhancement mentioned in #2717.
When the type is exactly the same thing as the value, the type is not printed to docs.

@Corso02
Copy link
Contributor Author

Corso02 commented Sep 30, 2024

Hi @Gerrit0, thank you for your code review. I'll look into fixing the issues mentioned in the coming days. Would it be possible to assign me the #2717 issue? Thank you so much for your time.

@Corso02
Copy link
Contributor Author

Corso02 commented Sep 30, 2024

I managed to fix most of the issues, below I have some examples of what I looked into.

Code: const falseVal = false;
Output:
image

Code: const zero = 0;
Output:
image

Code: const escaped_str_end = "Testing with escaped at the end\n"
Output:
image
(This works the same with escaped character at the start or in the middle)

I have one question.
Consider this code:
const bigNumber = 9007199254740991n;
I get the output below:
image

Is this the correct output? Or should it be different? Thanks in advance.

@Corso02 Corso02 requested a review from Gerrit0 September 30, 2024 16:09
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 3, 2024

Thanks!

Consider this code: const bigNumber = 9007199254740991n;

Huh, apparently the default value conversion code doesn't handle bigint literals, I thought it did. The code you've added now will just handle it once I fix that issue though :)

@Gerrit0 Gerrit0 merged commit 1dbfe3a into TypeStrong:master Oct 3, 2024
5 checks passed
@Gerrit0 Gerrit0 added this to the v0.26.7 milestone Oct 3, 2024
Gerrit0 added a commit that referenced this pull request Oct 3, 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

Successfully merging this pull request may close these issues.

2 participants