Task #4282
closed
Rename 'artifact' to '_artifact'
Status:
CLOSED - DUPLICATE
Description
In light of the 4206 refactor [0] to change some Content fields to begin with a '_', of particular note the now '_artifacts' field, it would be clearer to update 'artifact' to '_artifact' to eliminate potential confusion.
[0] https://pulp.plan.io/issues/4206
- Tracker changed from Issue to Task
- % Done set to 0
- Tags Pulp 3 RC Blocker added
To some extent this is a discussion issue to determine if we should do this.
From: https://pulp.plan.io/issues/4206:
Motivations
1. Avoiding attribute naming collisions when content writer's subclass Content.
2. Allow users to easily see which attributes are from pulpcore and therefore common to all content types.
Additionally, we decided in https://pulp.plan.io/issues/3678 to not include artifact as a common pattern in Pulp core.
Thus, artifact is a convention right now. As it is not a convention enforced or suggested by the Pulp core API, I would leave it as it is.
That being said, I wouldn't mind _artifact too much, either.
- Groomed changed from No to Yes
- Sprint Candidate changed from No to Yes
- Sprint set to Sprint 47
- Status changed from NEW to ASSIGNED
- Assignee set to ppicka
- Sprint changed from Sprint 47 to Sprint 48
- Status changed from ASSIGNED to CLOSED - DUPLICATE
After discussing this with Brian, Jeff, and David, we decided to fix this more permanently in a different way, by moving the functionality into pulpcore.
https://pulp.plan.io/issues/4366
I'm really sorry Pavel! I copied over some of your changes to my own PR. It sucks that the work ended up overlapping.
- Has duplicate Story #4366: As a plugin writer, I have special purpose Content Serializers for content types that have 0, 1, or many artifacts per content added
- Tags deleted (
Pulp 3, Pulp 3 RC Blocker)
Also available in: Atom
PDF
.