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

[Maybe] Use name or title consistently? #91

Open
pcraig3 opened this issue Dec 6, 2024 · 0 comments
Open

[Maybe] Use name or title consistently? #91

pcraig3 opened this issue Dec 6, 2024 · 0 comments
Labels
Dev This is a dev priority ticket, not strictly user-facing.

Comments

@pcraig3
Copy link
Collaborator

pcraig3 commented Dec 6, 2024

We have 3 objects in our NOFO objects.

  1. Nofo
  2. Section
  3. Subsection

They are in a one-to-many hierarchical relationships. So 1 Nofo can have many Sections. And 1 Section can have many Subsections.

However, one thing that I find very confusing is the "name", "title" fields. Looking at those models, it goes like this:

  • nofo.title
  • section.name
  • subsection.name

I used "title" because that's what Grants.Gov is using (example here: https://grants.gov/search-results-detail/355839) but "name" seemed more appropriate for the smaller sections and subsections. It was 100% up to me what we called them and I walked right into this rake. But it annoys me that we call this field different things when it performs the same function.

Changing them would be a bunch of work and mean having to migrate the data but I find this very annoying.

If we wanted to do this, we would need to pick which one to go with (maybe "title" for everything?) and then migrate.

We can only do this before we have a public API, otherwise we will cause a breaking change and it will be much harder to coordinate that.

@pcraig3 pcraig3 added the Dev This is a dev priority ticket, not strictly user-facing. label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev This is a dev priority ticket, not strictly user-facing.
Projects
None yet
Development

No branches or pull requests

1 participant