crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: rename SupportedDocJson field to SolDoc

Browse Source 
from Solidity

https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219976199
https://github.com/0xProject/0x-monorepo/pull/1004
This commit is contained in:
F. Eugene Aumson
2018-09-25 14:35:18 -04:00
parent 574270d061
commit e8c8d3e722
5 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/react-docs/src/components/documentation.tsx
View File

@@ -329,7 +329,7 @@ export class Documentation extends React.Component<DocumentationProps, Documenta
return <div>{externalExports}</div>;
}
private _renderNetworkBadgesIfExists(sectionName: string): React.ReactNode {
if (this.props.docsInfo.type !== SupportedDocJson.Solidity) {
if (this.props.docsInfo.type !== SupportedDocJson.SolDoc) {
return null;
}

2
packages/react-docs/src/types.ts
View File

@@ -38,7 +38,7 @@ export enum KindString {
}
export enum SupportedDocJson {
Solidity = 'SOLIDITY',
SolDoc = 'SOL_DOC',
TypeDoc = 'TYPEDOC',
}

2
packages/react-docs/src/utils/constants.ts
View File

@@ -4,7 +4,7 @@ export const constants = {
TYPES_SECTION_NAME: 'types',
EXTERNAL_EXPORTS_SECTION_NAME: 'external exports',
TYPE_TO_SYNTAX: {
[SupportedDocJson.Solidity]: 'solidity',
[SupportedDocJson.SolDoc]: 'solidity',
[SupportedDocJson.TypeDoc]: 'typescript',
} as { [supportedDocType: string]: string },
};

2
packages/website/ts/containers/smart_contracts_documentation.ts
View File

@@ -17,7 +17,7 @@ const IntroMarkdownV2 = require('md/docs/smart_contracts/2.0.0/introduction');
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.SmartContracts,
packageName: 'contracts',
type: SupportedDocJson.Solidity,
type: SupportedDocJson.SolDoc,
displayName: '0x Smart Contracts',
packageUrl: 'https://github.com/0xProject/contracts',
markdownMenu: {

2
packages/website/ts/pages/documentation/doc_page.tsx
View File

@@ -141,7 +141,7 @@ export class DocPage extends React.Component<DocPageProps, DocPageState> {
versionDocObj as GeneratedDocJson,
this.props.docsInfo,
).convertToDocAgnosticFormat();
} else if (this.props.docsInfo.type === SupportedDocJson.Solidity) {
} else if (this.props.docsInfo.type === SupportedDocJson.SolDoc) {
// documenting solidity.
docAgnosticFormat = versionDocObj as DocAgnosticFormat;
// need to modify docsInfo like convertToDocAgnosticFormat() would do