aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs
diff options
context:
space:
mode:
authorAlex Browne <stephenalexbrowne@gmail.com>2019-01-10 04:12:05 +0800
committerAlex Browne <stephenalexbrowne@gmail.com>2019-01-11 09:41:13 +0800
commit89e398fa39fd14c9fd4a467fdd039920fb28a420 (patch)
tree95a50e9d5c151d66f155de77d08cc203f250cccf /packages/react-docs
parent53fc860d6190c19f13c451eb89dd5c0c1cdcd1f4 (diff)
downloaddexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.tar
dexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.tar.gz
dexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.tar.bz2
dexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.tar.lz
dexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.tar.xz
dexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.tar.zst
dexon-sol-tools-89e398fa39fd14c9fd4a467fdd039920fb28a420.zip
Update prettier to version ^1.15.3
Diffstat (limited to 'packages/react-docs')
-rw-r--r--packages/react-docs/CHANGELOG.json12
-rw-r--r--packages/react-docs/README.md24
-rw-r--r--packages/react-docs/src/components/doc_reference.tsx24
-rw-r--r--packages/react-docs/src/components/interface.tsx3
-rw-r--r--packages/react-docs/src/components/signature_block.tsx18
-rw-r--r--packages/react-docs/src/components/type.tsx9
6 files changed, 43 insertions, 47 deletions
diff --git a/packages/react-docs/CHANGELOG.json b/packages/react-docs/CHANGELOG.json
index 13109e613..02608f18d 100644
--- a/packages/react-docs/CHANGELOG.json
+++ b/packages/react-docs/CHANGELOG.json
@@ -337,18 +337,15 @@
"version": "0.0.5",
"changes": [
{
- "note":
- "Handle `reflection` type rendering so that anonymous function type declarations render properly",
+ "note": "Handle `reflection` type rendering so that anonymous function type declarations render properly",
"pr": 465
},
{
- "note":
- "Rename `MethodSignature` to `Signature` and change it's props so that it can be used to render method and function signatures.",
+ "note": "Rename `MethodSignature` to `Signature` and change it's props so that it can be used to render method and function signatures.",
"pr": 465
},
{
- "note":
- "Rename `MethodBlock` to `SignatureBlock` since it is not used to render method and function signature blocks.",
+ "note": "Rename `MethodBlock` to `SignatureBlock` since it is not used to render method and function signature blocks.",
"pr": 465
},
{
@@ -362,8 +359,7 @@
"version": "0.0.3",
"changes": [
{
- "note":
- "Move TS typings from devDependencies to dependencies since they are needed by the package user."
+ "note": "Move TS typings from devDependencies to dependencies since they are needed by the package user."
}
],
"timestamp": 1521298800
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md
index 19c092e4d..7b1f4f80a 100644
--- a/packages/react-docs/README.md
+++ b/packages/react-docs/README.md
@@ -11,15 +11,15 @@ A full-page React component for rendering beautiful documentation for Solidity a
#### Features
-* Mobile optimized
-* Reads Javadoc-style comments in your code to generate class/method/argument/return/type comments.
-* Syntax highlighting support for TypeScript & Solidity
-* Type declaration linking
-* Type declaration popovers to avoid clicking through to the definition
-* Section/method/type anchors for easily pointing others to a specific part of your docs.
-* Version picker
-* Customizable sidebar header
-* Supports custom markdown sections so you can easily add an intro or installation instructions.
+- Mobile optimized
+- Reads Javadoc-style comments in your code to generate class/method/argument/return/type comments.
+- Syntax highlighting support for TypeScript & Solidity
+- Type declaration linking
+- Type declaration popovers to avoid clicking through to the definition
+- Section/method/type anchors for easily pointing others to a specific part of your docs.
+- Version picker
+- Customizable sidebar header
+- Supports custom markdown sections so you can easily add an intro or installation instructions.
## Installation
@@ -45,9 +45,9 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol
Feel free to contribute to these improvements!
-* Allow user to pass in styling for all major elements similar to [Material-UI](http://www.material-ui.com/).
-* Allow user to define an alternative font and have it change everywhere.
-* Add source links to Solidity docs (currently unsupported by solc, which underlies sol-doc).
+- Allow user to pass in styling for all major elements similar to [Material-UI](http://www.material-ui.com/).
+- Allow user to define an alternative font and have it change everywhere.
+- Add source links to Solidity docs (currently unsupported by solc, which underlies sol-doc).
## Contributing
diff --git a/packages/react-docs/src/components/doc_reference.tsx b/packages/react-docs/src/components/doc_reference.tsx
index 85547576b..424fe9ecf 100644
--- a/packages/react-docs/src/components/doc_reference.tsx
+++ b/packages/react-docs/src/components/doc_reference.tsx
@@ -194,21 +194,19 @@ export class DocReference extends React.Component<DocReferenceProps, DocReferenc
<div>{functionDefs}</div>
</div>
)}
- {!_.isUndefined(docSection.events) &&
- docSection.events.length > 0 && (
- <div>
- <h2 style={headerStyle}>Events</h2>
- <div>{eventDefs}</div>
- </div>
- )}
+ {!_.isUndefined(docSection.events) && docSection.events.length > 0 && (
+ <div>
+ <h2 style={headerStyle}>Events</h2>
+ <div>{eventDefs}</div>
+ </div>
+ )}
{!_.isUndefined(docSection.externalExportToLink) &&
this._renderExternalExports(docSection.externalExportToLink)}
- {!_.isUndefined(typeDefs) &&
- typeDefs.length > 0 && (
- <div>
- <div>{typeDefs}</div>
- </div>
- )}
+ {!_.isUndefined(typeDefs) && typeDefs.length > 0 && (
+ <div>
+ <div>{typeDefs}</div>
+ </div>
+ )}
<div
style={{
width: '100%',
diff --git a/packages/react-docs/src/components/interface.tsx b/packages/react-docs/src/components/interface.tsx
index 0df44ca1c..06896159f 100644
--- a/packages/react-docs/src/components/interface.tsx
+++ b/packages/react-docs/src/components/interface.tsx
@@ -45,7 +45,8 @@ export const Interface: React.SFC<InterfaceProps> = (props: InterfaceProps): any
typeDefinitionByName={props.typeDefinitionByName}
isInPopover={props.isInPopover}
/>
- )},
+ )}
+ ,
</span>
);
});
diff --git a/packages/react-docs/src/components/signature_block.tsx b/packages/react-docs/src/components/signature_block.tsx
index 7cdf19bb0..3189d86cf 100644
--- a/packages/react-docs/src/components/signature_block.tsx
+++ b/packages/react-docs/src/components/signature_block.tsx
@@ -91,16 +91,14 @@ export class SignatureBlock extends React.Component<SignatureBlockProps, Signatu
/>
)}
{method.comment && <Comment comment={method.comment} className="py2" />}
- {method.parameters &&
- !_.isEmpty(method.parameters) &&
- hasExclusivelyNamedParams && (
- <div>
- <h4 className="pb1 thin" style={{ borderBottom: '1px solid #e1e8ed' }}>
- ARGUMENTS
- </h4>
- {this._renderParameterDescriptions(method.parameters, method.name)}
- </div>
- )}
+ {method.parameters && !_.isEmpty(method.parameters) && hasExclusivelyNamedParams && (
+ <div>
+ <h4 className="pb1 thin" style={{ borderBottom: '1px solid #e1e8ed' }}>
+ ARGUMENTS
+ </h4>
+ {this._renderParameterDescriptions(method.parameters, method.name)}
+ </div>
+ )}
{method.returnComment && (
<div className="pt1 comment">
<h4 className="pb1 thin" style={{ borderBottom: '1px solid #e1e8ed' }}>
diff --git a/packages/react-docs/src/components/type.tsx b/packages/react-docs/src/components/type.tsx
index fa3b658b4..894c3f560 100644
--- a/packages/react-docs/src/components/type.tsx
+++ b/packages/react-docs/src/components/type.tsx
@@ -53,7 +53,8 @@ export const Type: React.SFC<TypeProps> = (props: TypeProps): any => {
typeDefinitionByName={props.typeDefinitionByName}
docsInfo={props.docsInfo}
isInPopover={props.isInPopover}
- />[]
+ />
+ []
</span>
);
} else {
@@ -181,9 +182,11 @@ export const Type: React.SFC<TypeProps> = (props: TypeProps): any => {
});
typeName = (
<div>
- [{_.reduce(tupleTypes, (prev: React.ReactNode, curr: React.ReactNode) => {
+ [
+ {_.reduce(tupleTypes, (prev: React.ReactNode, curr: React.ReactNode) => {
return [prev, ', ', curr];
- })}]
+ })}
+ ]
</div>
);
break;