Skip to content
Prev Previous commit
Next Next commit
refactor: GenerateCode -> argparseCode
  • Loading branch information
HaeckelK committed Feb 14, 2022
commit cee7ada3edc5fea79af8fc6be0e37f51723036a3
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Within HTML:
<script src="https://unpkg.com/python-argparse-generator/lib/index.js"></script>
</head>
<script>
const pythonCode = GenerateCode([
const pythonCode = argparseCode([
{ name: 'folder', type: 'str', variableName: 'folder', default: '"/data"', defaultDisplay: '"/data"' },
{ name: 'limit', type: 'int', variableName: 'limit', default: '10', defaultDisplay: '10' },
]);
Expand All @@ -40,14 +40,14 @@ Within HTML:
Within Typescript:

```ts
import { Argument, GenerateCode } from 'python-argparse-generator';
import { Argument, argparseCode } from 'python-argparse-generator';

const args: Argument[] = [
{ name: 'folder', type: 'str', variableName: 'folder', default: '"/data"', defaultDisplay: '"/data"' },
{ name: 'limit', type: 'int', variableName: 'limit', default: '10', defaultDisplay: '10' },
];

const pythonCode = GenerateCode(args);
const pythonCode = argparseCode(args);
```

Where content of `pythonCode` string is:
Expand Down
4 changes: 2 additions & 2 deletions python-argparse-generator/src/__tests__/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { GenerateCode } from '../index';
import { argparseCode } from '../index';

test('Basic check of output', () => {
expect(
GenerateCode([
argparseCode([
{
name: 'folder',
type: 'str',
Expand Down
2 changes: 1 addition & 1 deletion python-argparse-generator/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function argumentToText(argument: Argument) {

const argumentToMainParams = (argument: Argument) => `${argument.variableName}: ${argument.type}`;

export const GenerateCode = (args: Argument[]) => {
export const argparseCode = (args: Argument[]) => {
const mainParameters: string[] = args.map((arg) => argumentToMainParams(arg));
const argumentsText: string[] = args.map((arg) => argumentToText(arg));
const returnText: string[] = args.map((x) => {
Expand Down