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

Improve readability of source code #1889

Merged
merged 21 commits into from
Mar 20, 2022
Merged

Improve readability of source code #1889

merged 21 commits into from
Mar 20, 2022

Conversation

fb55
Copy link
Contributor

@fb55 fb55 commented Mar 20, 2022

I recently ran into #1606 (see inikulin/parse5#467). I spent a couple of hours trying to understand the source code of TypeDoc, and made small changes whenever it took me longer to understand a piece of code than it should have. The commits should be helpful as a description of why things were changed.

I've targeted the beta branch — hope this is where commits should be added.

Copy link
Collaborator

@Gerrit0 Gerrit0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like most of the changes, thanks! A few comments...

src/lib/converter/converter.ts Outdated Show resolved Hide resolved
src/lib/converter/converter.ts Outdated Show resolved Hide resolved
src/lib/converter/factories/index-signature.ts Outdated Show resolved Hide resolved
src/lib/converter/jsdoc.ts Outdated Show resolved Hide resolved
src/lib/converter/plugins/SourcePlugin.ts Outdated Show resolved Hide resolved
src/lib/utils/sort.ts Outdated Show resolved Hide resolved
src/lib/validation/documentation.ts Outdated Show resolved Hide resolved
src/lib/utils/entry-point.ts Show resolved Hide resolved
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 20, 2022

Ignore the CI failure for visual regression, not caused by your changes.

@Gerrit0 Gerrit0 merged commit 709d291 into TypeStrong:beta Mar 20, 2022
fb55 added a commit to fb55/typedoc that referenced this pull request Mar 22, 2022
Similar to TypeStrong#1889 — improves some code to make it more readable.
@fb55 fb55 mentioned this pull request Mar 22, 2022
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