Skip to content

Commit 645f36c

Browse files
committed
cleanup
1 parent c1f8277 commit 645f36c

134 files changed

Lines changed: 1571 additions & 1470 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,3 @@ geojson.xsd
1616
*.bak
1717
*.ipynb
1818
node_modules
19-

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ repos:
2929
hooks:
3030
# Run the linter
3131
- id: ruff
32-
args: [--fix, --exit-non-zero-on-fix, --output-format=full]
32+
args: [--fix, --exit-non-zero-on-fix, --output-format=full] #, --unsafe-fixes]
3333
# Run the formatter
3434
- id: ruff-format

docs/developer_resources.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55
Details of the deprecation policy are included in the BuildingSync XML schema file.
66

77
## Pull Requests
8+
89
### Summary
10+
911
BuildingSync uses Pull Requests (PRs) to track and report changes to users when creating releases. Specifically, we document changes to the schema/repo by using labels on PRs, thus we require developers to add labels to all PRs. Our CI will validate labels.
1012

1113
### Requirements
14+
1215
- PRs are our "source of truth" for important changes to the repo/schema
1316
- We encourage separate PRs for each "logical"/"discrete" change to the schema (especially if the changes are impactful/non-trivial to users). For example, removing an element from the schema should be separate from adding a choice to an unrelated element.
1417
- The labels for the PR indicate the implications of the changes. Our CI system will validate your labels. See [CI Labels](../.github/workflows/CI_Labels.yml) for more info.

docs/gbXML_reference.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ BuildingSync can reference the gbXML schema to allow gbXML-valid geometry data t
44

55
There are two examples in the examples folder:
66

7-
* `Single_building_gmxml_externalreference_geometry.xml`
8-
* `Multi_building_gmxml_externalreference_geometry.xml`
7+
- `Single_building_gmxml_externalreference_geometry.xml`
8+
- `Multi_building_gmxml_externalreference_geometry.xml`
99

1010
The examples are basic mockups of BuildingSync files with gbXML geometry data, showcasing the formatting of an end-case XML file and which validate against the both BuildingSync and gbXML schema while containing foreign gbXML data. The gbXML elements allowed are prefixed with (namespaced) with `gbXML`.
1111

12-
The elements are primarily geometry-specific elements that are children of gbXML's `<Space>` element and can be placed inside of a BuildingSync `<Space>` element. Note that any existing IDref-type attributes in the gbXML data may cause validation errors (depending the XML validator strictness), as they are referencing ID's of elements that are from the original gbXML instance file, which will not be present in the BuildingSync instance file. These can be removed a variety of ways; here's a simple XSLT transformation which can be applied to the document:
12+
The elements are primarily geometry-specific elements that are children of gbXML's `<Space>` element and can be placed inside of a BuildingSync `<Space>` element. Note that any existing IDref-type attributes in the gbXML data may cause validation errors (depending the XML validator strictness), as they are referencing ID's of elements that are from the original gbXML instance file, which will not be present in the BuildingSync instance file. These can be removed a variety of ways; here's a simple XSLT transformation which can be applied to the document:
1313

1414
<pre><code>
1515
&lt;xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"&gt;
@@ -22,4 +22,3 @@ The elements are primarily geometry-specific elements that are children of gbXML
2222
&lt;/xsl:stylesheet&gt;
2323
</code>
2424
</pre>
25-

docs/linking_elements.md

Lines changed: 62 additions & 62 deletions
Large diffs are not rendered by default.

docs/notebooks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Here you can find Jupyter Notebooks which serve as guides for using BuildingSync
22

33
# Setup
44

5-
From the root directory of the repo, run the following commands to set up the environment.
5+
From the root directory of the repo, run the following commands to set up the environment.
66

77
- `pip install poetry`
88
- `poetry install`

0 commit comments

Comments
 (0)