Skip to content

fix: typos in the docs #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tudorpintea999 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: typos in the docs #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa920fc
fix typo collection_parser.md
tudorpintea999 Dec 2, 2023
0900323
fix typo schema_parser.md
tudorpintea999 Dec 2, 2023
599df30
fix typo concepts.md
tudorpintea999 Dec 2, 2023
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
2 changes: 1 addition & 1 deletion docs/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ metadata = pipeline.run([token])[0]

By default, the pipeline uses `https://cloudflare-eth.com` as the provider for the `ContractCaller`.
This is a free Ethereum RPC provider, which means that it is very easy to exceed the rate-limit.
The code below illustrates how to use a custom RPC provider to prevent getting rate-limited if token uris need to be retireved from the contract:
The code below illustrates how to use a custom RPC provider to prevent getting rate-limited if token uris need to be retrieved from the contract:

```python
from offchain import MetadataPipeline
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/collection_parser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Each of these fields can be mapped into the standard metadata format:

---

And this is how it would look programatically:
And this is how it would look programmatically:

```python
class ENSParser(CollectionParser):
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/schema_parser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This should return the following data from the IPFS Gateway:
```json
{
"name": "Obligatory Song About the iPhone 5",
"description": "A new song, everyday, forever. Song A Day is an ever-growing collection of unique songs created by Jonathan Mann, starting January 1st, 2009. Each NFT is a 1:1 representation of that days song, and grants access to SongADAO, the orgninzation that controls all the rights and revenue to the songs. Own a piece of the collection to help govern the future of music. http://songaday.world",
"description": "A new song, everyday, forever. Song A Day is an ever-growing collection of unique songs created by Jonathan Mann, starting January 1st, 2009. Each NFT is a 1:1 representation of that days song, and grants access to SongADAO, the organization that controls all the rights and revenue to the songs. Own a piece of the collection to help govern the future of music. http://songaday.world",
"token_id": 1351,
"image": "ipfs://QmX2ZdS13khEYqpC8Jz4nm7Ub3He3g5Ws22z3QhunC2k58/1351",
"animation_url": "ipfs://QmVHjFbGEqXfYuoPpJR4vmRacGM29KR5UenqbidJex8muB/1351",
Expand Down Expand Up @@ -109,7 +109,7 @@ This should return the following data from the IPFS Gateway:

The next step is to convert the metadata into the [standardized metadata format](../models/metadata.md).

Each field in the new metadata format should either map a field in the standardized metadata format or be added as an `MetadataField` under the `additional_fields` property.
Each field in the new metadata format should either map a field in the standardized metadata format or be added as a `MetadataField` under the `additional_fields` property.

In the case of Song a Day, the metadata format has the following fields:

Expand All @@ -121,7 +121,7 @@ In the case of Song a Day, the metadata format has the following fields:
"image": "Image media asset",
"animation_url": "Media asset for videos",
"external_url": "External linking",
"youtube_url": "Video on hosted on Youtube"
"youtube_url": "Video hosted on Youtube"
}
```

Expand Down