mirror of
https://github.com/Steffo99/sophon.git
synced 2024-12-23 07:14:21 +00:00
🔧 Add help text to model fields
This commit is contained in:
parent
1b94a64330
commit
97400516e9
1 changed files with 38 additions and 6 deletions
|
@ -13,10 +13,26 @@ class DataSource(models.Model):
|
||||||
method.
|
method.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
pandasdmx_id = models.CharField("Internal pandasdmx source id", max_length=16, primary_key=True)
|
pandasdmx_id = models.CharField(
|
||||||
builtin = models.BooleanField("If the source is builtin in pandasdmx")
|
"PandaSDMX id",
|
||||||
|
help_text="Internal id used by PandaSDMX to reference the source.",
|
||||||
|
max_length=16,
|
||||||
|
primary_key=True,
|
||||||
|
)
|
||||||
|
|
||||||
settings = models.JSONField("Source info to pass to pandasdmx if the source is not builtin", null=True)
|
builtin = models.BooleanField(
|
||||||
|
"Builtin",
|
||||||
|
help_text="Whether the source is builtin in PandaSDMX or not.",
|
||||||
|
)
|
||||||
|
settings = models.JSONField(
|
||||||
|
"Settings",
|
||||||
|
help_text="Info parameter to pass to pandasdmx.add_source if the source is not builtin "
|
||||||
|
"(see https://pandasdmx.readthedocs.io/en/latest/api.html#pandasdmx.add_source).",
|
||||||
|
null=True
|
||||||
|
)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return self.pandasdmx_id
|
||||||
|
|
||||||
|
|
||||||
class Project(models.Model):
|
class Project(models.Model):
|
||||||
|
@ -24,7 +40,23 @@ class Project(models.Model):
|
||||||
A research :class:`.Project` is a work which may use zero or more :class:`.DataSource`\\ s to prove or disprove an
|
A research :class:`.Project` is a work which may use zero or more :class:`.DataSource`\\ s to prove or disprove an
|
||||||
hypothesis.
|
hypothesis.
|
||||||
"""
|
"""
|
||||||
name = models.CharField("Project name", max_length=512)
|
|
||||||
description = models.CharField("Project description", max_length=8192)
|
|
||||||
|
|
||||||
sources = models.ManyToManyField(DataSource, related_name="used_in")
|
name = models.CharField(
|
||||||
|
"Project name",
|
||||||
|
help_text="The display name of the project.",
|
||||||
|
max_length=512,
|
||||||
|
)
|
||||||
|
description = models.CharField(
|
||||||
|
"Project description",
|
||||||
|
help_text="A brief description of the project, to be displayed inthe overview.",
|
||||||
|
max_length=8192,
|
||||||
|
)
|
||||||
|
|
||||||
|
sources = models.ManyToManyField(
|
||||||
|
DataSource,
|
||||||
|
help_text="The sources used by this project.",
|
||||||
|
related_name="used_in"
|
||||||
|
)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return self.name
|
||||||
|
|
Loading…
Reference in a new issue