Prodream/ormar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #29 from HarrySky/master

Browse Source 
Fix inconsistencies in documentation
This commit is contained in:
collerek
2020-11-04 11:44:18 +07:00
committed by GitHub
parent 8e2a368203 a72478d33d
commit d6896fb134
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -79,8 +79,8 @@ class Album(ormar.Model):
# note that type hints are optional so # note that type hints are optional so
# id = ormar.Integer(primary_key=True) # id = ormar.Integer(primary_key=True)
# is also valid # is also valid
id = ormar.Integer(primary_key=True) id: int = ormar.Integer(primary_key=True)
name = ormar.String(length=100) name: str = ormar.String(max_length=100)
class Track(ormar.Model): class Track(ormar.Model):
@ -89,10 +89,10 @@ class Track(ormar.Model):
metadata = metadata metadata = metadata
database = database database = database
id = ormar.Integer(primary_key=True) id: int = ormar.Integer(primary_key=True)
album = ormar.ForeignKey(Album) album: Optional[Album] = ormar.ForeignKey(Album)
title = ormar.String(length=100) title: str = ormar.String(max_length=100)
position = ormar.Integer() position: int = ormar.Integer()
# Create some records to work with. # Create some records to work with.

12
docs/index.md
View File

@ -79,8 +79,8 @@ class Album(ormar.Model):
# note that type hints are optional so # note that type hints are optional so
# id = ormar.Integer(primary_key=True) # id = ormar.Integer(primary_key=True)
# is also valid # is also valid
id = ormar.Integer(primary_key=True) id: int = ormar.Integer(primary_key=True)
name = ormar.String(length=100) name: str = ormar.String(max_length=100)
class Track(ormar.Model): class Track(ormar.Model):
@ -89,10 +89,10 @@ class Track(ormar.Model):
metadata = metadata metadata = metadata
database = database database = database
id = ormar.Integer(primary_key=True) id: int = ormar.Integer(primary_key=True)
album = ormar.ForeignKey(Album) album: Optional[Album] = ormar.ForeignKey(Album)
title = ormar.String(length=100) title: str = ormar.String(max_length=100)
position = ormar.Integer() position: int = ormar.Integer()
# Create some records to work with. # Create some records to work with.

2
docs_src/models/docs005.py
View File

@ -50,7 +50,7 @@ Will produce:
'name': mappingproxy({'allow_blank': False, 'name': mappingproxy({'allow_blank': False,
'autoincrement': False, 'autoincrement': False,
'choices': set(), 'choices': set(),
'column_type': String(length=100), 'column_type': String(max_length=100),
'curtail_length': None, 'curtail_length': None,
'default': None, 'default': None,
'index': False, 'index': False,