Skip to content

Commit

Permalink
many small format changes to improve readability of slot pages
Browse files Browse the repository at this point in the history
  • Loading branch information
sierra-moxon committed Nov 28, 2023
1 parent e4969ca commit e2a4aef
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 19 deletions.
13 changes: 5 additions & 8 deletions src/doc-templates/class.md.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
{% if schemaview.class_parents(element.name) or schemaview.class_children(element.name, mixins=False) %}


## Inheritance:
## Inheritance
{{ gen.inheritance_tree(element, mixins=True) }}
{% else %}
<!-- no inheritance hierarchy -->
{% endif %}

## Slots:
## Slots

| Name | Cardinality and Range | Inheritance |
| --- | --- | --- |
Expand All @@ -40,7 +40,7 @@
{% endif %}

{% if schemaview.is_mixin(element.name) %}
## Mixin Usage:
## Mixin Usage

| mixed into | description |
| --- | --- |
Expand All @@ -50,7 +50,7 @@
{% endif %}

{% if schemaview.usage_index().get(element.name) %}
## Usages:
## Usages

| used by | used in | type | used |
| --- | --- | --- | --- |
Expand All @@ -61,9 +61,6 @@

{% include "common_metadata.md.jinja2" %}




{% if gen.example_object_blobs(element.name) -%}
## Examples:
{% for name, blob in gen.example_object_blobs(element.name) -%}
Expand All @@ -76,7 +73,7 @@
{% endif %}


## LinkML Source:
## LinkML Source

<details>
```yaml
Expand Down
6 changes: 3 additions & 3 deletions src/doc-templates/common_metadata.md.jinja2
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% if element.id_prefixes %}
## Valid ID Prefixes:
## Valid ID Prefixes

Instances of this class *should* have identifiers with one of the following prefixes, ordered with the most preferred first:

Expand All @@ -12,7 +12,7 @@ Instances of this class *should* have identifiers with one of the following pref


{% if schemaview.get_mappings(element.name).items() %}
## Mappings:
## Mappings

| Mapping Type | Mapped Value |
| --- | --- |
Expand All @@ -25,7 +25,7 @@ Instances of this class *should* have identifiers with one of the following pref


{% if element.annotations %}
## Annotations:
## Annotations

| property | value |
| --- | --- |
Expand Down
6 changes: 3 additions & 3 deletions src/doc-templates/enum.md.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ _{{ element_description_line }}_
{% endif %}

{% if element.permissible_values -%}
# Permissible Values:
## Permissible Values

| Value | Meaning | Description |
| --- | --- | --- |
Expand All @@ -21,7 +21,7 @@ _This is a dynamic enum_

{% set slots_for_enum = schemaview.get_slots_by_enum(element.name) %}
{% if slots_for_enum is defined and slots_for_enum|length > 0 -%}
# Slots:
## Slots

| Name | Description |
| --- | --- |
Expand All @@ -32,7 +32,7 @@ _This is a dynamic enum_

{% include "common_metadata.md.jinja2" %}

# LinkML Source:
## LinkML Source

<details>
```yaml
Expand Down
10 changes: 5 additions & 5 deletions src/doc-templates/slot.md.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
```
{% endfor %}
{% endif %}
## Inheritance:
## Inheritance

{{ gen.inheritance_tree(element, mixins=True) }}
{% else %}
Expand All @@ -30,7 +30,7 @@

{% if schemaview.get_classes_by_slot(element, include_induced=False) %}

## Applicable Classes:
## Applicable Classes

| Name | Description | Modifies Slot |
| --- | --- | --- |
Expand All @@ -42,7 +42,7 @@


{% if schemaview.is_mixin(element.name) %}
## Mixin Usage:
## Mixin Usage

| mixed into | description | range | domain |
| --- | --- | --- | --- |
Expand All @@ -53,7 +53,7 @@


{% if schemaview.usage_index().get(element.name) %}
## Usages:
## Usages

| used by | used in | type | used |
| --- | --- | --- | --- |
Expand All @@ -64,7 +64,7 @@

{% include "common_metadata.md.jinja2" %}

## LinkML Source:
## LinkML Source

<details>
```yaml
Expand Down

0 comments on commit e2a4aef

Please sign in to comment.