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

Feature/episodes #14

Merged
merged 3 commits into from
Jan 29, 2024
Merged

Feature/episodes #14

merged 3 commits into from
Jan 29, 2024

Conversation

XanderVertegaal
Copy link
Contributor

This is a starting point for a discussion on how to resolve #8

In this PR:

  • The old 'Epistolary Event' model has been split in two models:
    • Letter Actions are atomic uses of a letter.
    • Epistolary Events are collections of letter actions.
  • A new model 'Case Study' has been added.
  • More human-friendly texts are shown in the admin forms. For instance: the case study form now says 'Add another Epistolary event' instead of the default "Add another Casestudy_epistolaryevent relationship".

@@ -4,64 +4,112 @@

class PersonNameAdmin(admin.StackedInline):
model = models.PersonName
fields = ['value', 'certainty', 'note']

fields = ["value", "certainty", "note"]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

My editor automatically uses Black. I could turn this off for this project, but it may not be a bad idea to agree on a formatter.

Copy link
Contributor

Choose a reason for hiding this comment

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

I personally don't mind formatting inconsistencies, but if you prefer we use the same formatter, I can install it.

Copy link
Contributor

Choose a reason for hiding this comment

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

What I do mind is (auto-)formatting an entire file when you're changing a few lines of content. It makes the review more difficult, as meaningful changes get cluttered by meaningless ones.

Anyway, we can choose something in our next meeting. It's a good idea to decide on this early in the project.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed! In the meantime, I'll turn off Black for this project to avoid large meaningless diffs.


These can be grouped into epistolary events.
"""

letters = models.ManyToManyField(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

A LetterAction currently contains multiple letters; it inherited this from the old EpistolaryEvent model. What would you say if we made this a 1-to-1 relationship? That would fit the idea of an 'atomic' action more.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would agree that "atomic" implies it's one-to-one, but maybe this doesn't make sense for the researchers. If a messenger delivers three letters at once, you could consider that an "atomic action" as it can't be broken up into a sequence of actions.

I'd keep it like this for now, and check in in our next meeting.


For instance, a political campaign (epistolary event) may consist of the writing, transporting and reading of individual letters (letter actions).
"""

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I considered making EpistolaryEvents nestable, so one epistolary event (e.g. 'the Election of Pope Clement III') can have multiple Epistolary Events (e.g. 'Council of Troyes' and 'Murder of Baldwin of Nantes') etc., but we should probably ask the team first before we needlessly add more layers of complexity.

Copy link
Contributor

Choose a reason for hiding this comment

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

I had the same idea. Indeed, let's do it like this for now, and check how the team wants to connect events. I can also imagine horizontal connections rather than hierarchical ones.

Copy link
Contributor

@lukavdplas lukavdplas left a comment

Choose a reason for hiding this comment

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

Nice!


For instance, a political campaign (epistolary event) may consist of the writing, transporting and reading of individual letters (letter actions).
"""

Copy link
Contributor

Choose a reason for hiding this comment

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

I had the same idea. Indeed, let's do it like this for now, and check how the team wants to connect events. I can also imagine horizontal connections rather than hierarchical ones.


These can be grouped into epistolary events.
"""

letters = models.ManyToManyField(
Copy link
Contributor

Choose a reason for hiding this comment

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

I would agree that "atomic" implies it's one-to-one, but maybe this doesn't make sense for the researchers. If a messenger delivers three letters at once, you could consider that an "atomic action" as it can't be broken up into a sequence of actions.

I'd keep it like this for now, and check in in our next meeting.

@XanderVertegaal XanderVertegaal merged commit 80c7e31 into develop Jan 29, 2024
2 checks passed
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.

Abstraction hierarchy: actions - episodes - sagas/case studies
2 participants