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

Feature: UI fixes and readability enhancements #230

Merged
merged 1 commit into from
May 31, 2021

Conversation

tgreyuk
Copy link
Member

@tgreyuk tgreyuk commented May 29, 2021

Motivation

Documentation could be improved by reducing clutter and removing repeated items. Also there is inconsistency of use of style to define types.

This feature makes several improvements to the UI with the aim to address these issues.

Improvements

  • There is a mix use of backticks and italics for primitive and literal types for emphasis. All these types should consistently use backticks.
  • Removing use of italics for reference types as can be hard to read.
  • Removed parameter types inside function parenthesis as it can become hard to read with complex types and they are defined in params table just below anyway.
  • Use h4 for 'Returns' and 'Defined in' headings to make more readable and consistent.
  • Fixed nested heading structure under 'Type declarations' heading.
  • Simplified Type parameter tables.
  • Simplified class constructors.
  • Some additional minor cleanups.

tgreyuk added a commit that referenced this pull request May 29, 2021
@tgreyuk tgreyuk force-pushed the feature/ui-enhancements branch from 5c06868 to def9a62 Compare May 29, 2021 09:20
tgreyuk added a commit that referenced this pull request May 29, 2021
@tgreyuk tgreyuk force-pushed the feature/ui-enhancements branch from def9a62 to 456637b Compare May 29, 2021 22:47
@tgreyuk tgreyuk changed the title Feature: UI readability enhancements Feature: UI fixes readability enhancements May 30, 2021
@tgreyuk tgreyuk force-pushed the feature/ui-enhancements branch from 456637b to 4aa9fbd Compare May 30, 2021 21:45
@tgreyuk tgreyuk changed the title Feature: UI fixes readability enhancements Feature: UI fixes and readability enhancements May 30, 2021
@tgreyuk tgreyuk force-pushed the feature/ui-enhancements branch from 4aa9fbd to f4329a9 Compare May 30, 2021 21:55
@tgreyuk tgreyuk merged commit f0ee1a4 into master May 31, 2021
@tgreyuk tgreyuk deleted the feature/ui-enhancements branch June 2, 2021 20:31
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.

1 participant