Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,15 @@ pre-commit run --all-files <ID of the task>

Alternatively, the linting tools can be set up to run automatically whenever you issue a `git commit` command, as
follows:

```shell
pre-commit install
```

## Construction of author keys

There are various source keys in CFF that can be used to convert to a target format. The code uses a pattern of first
identifiying what information is present, then summarizing this as a key, then using that key to retrieve a method which
identifying what information is present, then summarizing this as a key, then using that key to retrieve a method which
is tailored only to that specific combination of source keys. As an example of this mapping, see the setup in
https://github.com/citation-file-format/cffconvert/blob/3.0.0a0/cffconvert/behavior_shared/schemaorg_author_shared.py

Expand Down Expand Up @@ -306,10 +306,10 @@ The table below lists how the key name is constructed based what information was
## Construction of identifier keys

There are various source keys in CFF that can be used to convert to a target format. The code uses a pattern of first
identifiying what information is present, then summarizing this as a key, then using that key to retrieve a method which
is tailored only to that specific combination of source keys.
identifying what information is present, then summarizing this as a key, then using that key to retrieve a method which
is tailored only to that specific combination of source keys.

Source keys:
Source keys:

- `doi`
- `identifiers[i].type==doi`
Expand All @@ -326,8 +326,8 @@ The table below lists how the key name is constructed based what information was
## Construction of URL keys

There are various source keys in CFF that can be used to convert to a target format. The code uses a pattern of first
identifiying what information is present, then summarizing this as a key, then using that key to retrieve a method which
is tailored only to that specific combination of source keys.
identifying what information is present, then summarizing this as a key, then using that key to retrieve a method which
is tailored only to that specific combination of source keys.

Source keys:

Expand All @@ -339,7 +339,7 @@ Source keys:

The table below lists how the key name is constructed based what information was provided in the `CITATION.cff` file:

| key | has indentifiers url | has repository | has repository-artifact | has repository-code | has url |
| key | has identifiers url | has repository | has repository-artifact | has repository-code | has url |
|---------|----------------------|----------------|-------------------------|---------------------|---------|
| `IRACU` | True | True | True | True | True |
| `IRAC_` | True | True | True | True | False |
Expand Down Expand Up @@ -394,13 +394,13 @@ The table below lists how the key name is constructed based what information was

# check if cffconvert works, e.g.
cffconvert --version

# run the tests, make sure they pass
python3 -m pip pytest tests

# git push everything, merge into main as appropriate
```

3. publishing on test instance of PyPI

```shell
Expand All @@ -420,17 +420,17 @@ The table below lists how the key name is constructed based what information was
# make a source distribution:
python setup.py sdist
# make a wheel
python setup.py bdist_wheel
python setup.py bdist_wheel
# install the 'upload to pypi/testpypi tool' aka twine
pip install .[publishing]
# upload the contents of the source distribution we just made (requires credentials for test.pypi.org)
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

4. Checking the package

Open another shell but keep the other one. We'll return to the first shell momentarily.

Verify that there is a new version of the package on Test PyPI https://test.pypi.org/project/cffconvert/

```shell
Expand Down
2 changes: 1 addition & 1 deletion src/cffconvert/lib/cff_1_3_x/zenodo.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def add_contributors(self):
contributors = []
for c in self.cffobj.get("contributors", []):
# contributors are generated in the same way as authors, hence just
# call ZenodoAuthor's contructor with the cff contributor object
# call ZenodoAuthor's constructor with the cff contributor object
contributor = ZenodoAuthor(c).as_dict()
contributor.update({"type": "Other"})
contributors.append(contributor)
Expand Down
2 changes: 1 addition & 1 deletion src/cffconvert/schemas/1.2.0/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -994,7 +994,7 @@
"description": "The person's address."
},
"affiliation": {
"description": "The person's affilitation.",
"description": "The person's affiliation.",
"minLength": 1,
"type": "string"
},
Expand Down