Skip to content
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.

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

Proposal to harmonize definitions of PremisesAffected and LinkedPremises #59

Merged

Conversation

markborkum
Copy link
Contributor

…edPremises` elements.

@markborkum markborkum changed the title Add proposal to harmonize definitions of PremisesAffected and `Link… Proposal to harmonize definitions of PremisesAffected and LinkedPremises Aug 27, 2018
This proposal is to harmonize the definition of the `PremisesAffected` element with that of the `LinkedPremises` element. For example:

```xml
<Measure>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks nice. I like that we can reuse LinkedPremises and remove the Premise word which is a made up word for this context.

Tagging @jasondegraw

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nllong It makes the most sense to me to just reuse LinkedPremises without modification and remove the PremisesAffected element entirely.


Note that:

* The `PremisesAffected` element is a child of the `Measure` element. Within each `PremiseAffected` element, there may be a child `MeasureCoverage` element.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you suggest moving MeasureCoverage to another level, or adding MeasureCoverage to LinkedPremises?

Copy link
Contributor

@jasondegraw jasondegraw Sep 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this context, adding a MeasureCoverage element is redundant. We can edit the documentation of the LinkedPremises so that it is no longer so system-centric, which should be enough to use the element without structural additions.

Note that:

* The `PremisesAffected` element is a child of the `Measure` element. Within each `PremiseAffected` element, there may be a child `MeasureCoverage` element.
* Unlike the `LinkedPremises` element and its child elements, the `PremiseAffected` element does not indicate the type of the referenced element (the target of the `IDref` attribute).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is a big issue.

Copy link
Contributor

@jasondegraw jasondegraw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My main comment is that we should use the LinkedPremises element here without modification. Adding measure-specific tags risks confusion, and we've already got the floor areas element in there.

This proposal is to harmonize the definition of the `PremisesAffected` element with that of the `LinkedPremises` element. For example:

```xml
<Measure>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nllong It makes the most sense to me to just reuse LinkedPremises without modification and remove the PremisesAffected element entirely.


Note that:

* The `PremisesAffected` element is a child of the `Measure` element. Within each `PremiseAffected` element, there may be a child `MeasureCoverage` element.
Copy link
Contributor

@jasondegraw jasondegraw Sep 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this context, adding a MeasureCoverage element is redundant. We can edit the documentation of the LinkedPremises so that it is no longer so system-centric, which should be enough to use the element without structural additions.

<LinkedPremises>
<Site>
<LinkedSiteID IDref="Site1">
<MeasureCoverage>10</MeasureCoverage>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer that we use the currently implemented floor area element instead of adding an additional element here.

Copy link
Contributor

@jasondegraw jasondegraw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, apparently if you don't click "Submit review" nothing will happen. Sorry for the delay. This all looks good to me. We could switch up the details on the affected areas so we'd have better coverage of the options, but that isn't something to hold this up.

@nllong nllong merged commit e0d51f5 into BuildingSync:develop Oct 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants