From 53522a98b99d27ecfc4c782ca43e0f002050d6ee Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 29 Nov 2017 08:52:49 -0600 Subject: Rename packageName to displayName for clarity --- packages/website/ts/components/top_bar.tsx | 2 +- packages/website/ts/containers/connect_documentation.tsx | 2 +- packages/website/ts/containers/smart_contracts_documentation.tsx | 2 +- packages/website/ts/containers/zero_ex_js_documentation.tsx | 2 +- packages/website/ts/pages/documentation/docs_info.ts | 4 ++-- packages/website/ts/pages/documentation/documentation.tsx | 4 ++-- packages/website/ts/types.ts | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/website/ts/components/top_bar.tsx b/packages/website/ts/components/top_bar.tsx index 79abd5356..4398fe667 100644 --- a/packages/website/ts/components/top_bar.tsx +++ b/packages/website/ts/components/top_bar.tsx @@ -291,7 +291,7 @@ export class TopBar extends React.Component { return; } - const sectionTitle = `${this.props.docsInfo.packageName} Docs`; + const sectionTitle = `${this.props.docsInfo.displayName} Docs`; return (
{sectionTitle}
diff --git a/packages/website/ts/containers/connect_documentation.tsx b/packages/website/ts/containers/connect_documentation.tsx index f6ae53a30..3575538e1 100644 --- a/packages/website/ts/containers/connect_documentation.tsx +++ b/packages/website/ts/containers/connect_documentation.tsx @@ -27,7 +27,7 @@ const connectDocSections = { }; const docsInfoConfig: DocsInfoConfig = { - packageName: '0x Connect', + displayName: '0x Connect', subPackageName: 'connect', packageUrl: 'https://github.com/0xProject/0x.js', websitePath: WebsitePaths.Connect, diff --git a/packages/website/ts/containers/smart_contracts_documentation.tsx b/packages/website/ts/containers/smart_contracts_documentation.tsx index 4623c976b..ea2b19b8c 100644 --- a/packages/website/ts/containers/smart_contracts_documentation.tsx +++ b/packages/website/ts/containers/smart_contracts_documentation.tsx @@ -20,7 +20,7 @@ const IntroMarkdown = require('md/docs/smart_contracts/introduction'); const sections = constants.smartContractDocSections; const docsInfoConfig: DocsInfoConfig = { - packageName: '0x Smart Contracts', + displayName: '0x Smart Contracts', packageUrl: 'https://github.com/0xProject/contracts', websitePath: WebsitePaths.SmartContracts, docsJsonRoot: 'https://s3.amazonaws.com/smart-contracts-docs-json', diff --git a/packages/website/ts/containers/zero_ex_js_documentation.tsx b/packages/website/ts/containers/zero_ex_js_documentation.tsx index cbb8fce5f..fc48297b5 100644 --- a/packages/website/ts/containers/zero_ex_js_documentation.tsx +++ b/packages/website/ts/containers/zero_ex_js_documentation.tsx @@ -39,7 +39,7 @@ const zeroExJsDocSections = { }; const docsInfoConfig: DocsInfoConfig = { - packageName: '0x.js', + displayName: '0x.js', packageUrl: 'https://github.com/0xProject/0x.js', subPackageName: '0x.js', websitePath: WebsitePaths.ZeroExJs, diff --git a/packages/website/ts/pages/documentation/docs_info.ts b/packages/website/ts/pages/documentation/docs_info.ts index 7fe5d9b31..1afcf8aaf 100644 --- a/packages/website/ts/pages/documentation/docs_info.ts +++ b/packages/website/ts/pages/documentation/docs_info.ts @@ -11,7 +11,7 @@ import { } from 'ts/types'; export class DocsInfo { - public packageName: string; + public displayName: string; public packageUrl: string; public subPackageName?: string; public websitePath: string; @@ -21,7 +21,7 @@ export class DocsInfo { public sectionNameToMarkdown: {[sectionName: string]: string}; private docsInfo: DocsInfoConfig; constructor(config: DocsInfoConfig) { - this.packageName = config.packageName; + this.displayName = config.displayName; this.packageUrl = config.packageUrl; this.subPackageName = config.subPackageName; this.websitePath = config.websitePath; diff --git a/packages/website/ts/pages/documentation/documentation.tsx b/packages/website/ts/pages/documentation/documentation.tsx index 27cd1da2c..be99e77a2 100644 --- a/packages/website/ts/pages/documentation/documentation.tsx +++ b/packages/website/ts/pages/documentation/documentation.tsx @@ -111,7 +111,7 @@ export class Documentation extends this.props.docsInfo.getMenuSubsectionsBySection(this.state.docAgnosticFormat); return (
- +

- {this.props.docsInfo.packageName} + {this.props.docsInfo.displayName}

{this.renderDocumentation()} diff --git a/packages/website/ts/types.ts b/packages/website/ts/types.ts index 96eae938d..d2c690ce1 100644 --- a/packages/website/ts/types.ts +++ b/packages/website/ts/types.ts @@ -674,7 +674,7 @@ export interface SectionsMap { } export interface DocsInfoConfig { - packageName: string; + displayName: string; packageUrl: string; websitePath: string; docsJsonRoot: string; -- cgit v1.2.3