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

Rename macros #40

Closed
Tracked by #31
Emoun opened this issue Dec 25, 2021 · 2 comments
Closed
Tracked by #31

Rename macros #40

Emoun opened this issue Dec 25, 2021 · 2 comments
Labels
D-accepted A decision (D) has been made and the issue will be worked on I-feature This issue (I) regards a (potential) feature in the project T-accepted Triage (T): Initial review accepted issue/PR as valid

Comments

@Emoun
Copy link
Owner

Emoun commented Dec 25, 2021

Short Description:

Rename the macros:
duplicate_inline -> duplicate (new),
duplicate(old) -> duplicate_item.

Motivation:

#28 decided that duplicate_inline would be used in nested substitution.
Therefore, the current name is a bit long for something that would probably be embedded inside other code.
duplicate(old) on the other hand is often on its own, or as part of shorter lines, so giving it a longer name wouldn't be an issue.

duplicate_inline is also the more general of the macros (everywhere can use duplicate(old) you can also use duplicate_inline, but not vice versa).
Therefore, if it has the shorter name, new users trying it out (without knowing the difference) would have faster success.

Design

Simple rename.

Misc:

Initially, we will simply rename everything in the documentation. However, since duplicate_inline will become the new default macro, we might want to refocus the documentation to account for this.

@Emoun Emoun added D-discussion A decision (D) has not been made yet and is open to discussion I-feature This issue (I) regards a (potential) feature in the project labels Dec 25, 2021
@github-actions github-actions bot added the T-new Triage (T): Has yet to be reviewed label Dec 25, 2021
@Emoun Emoun added D-accepted A decision (D) has been made and the issue will be worked on T-accepted Triage (T): Initial review accepted issue/PR as valid and removed D-discussion A decision (D) has not been made yet and is open to discussion T-new Triage (T): Has yet to be reviewed labels Dec 25, 2021
@Emoun
Copy link
Owner Author

Emoun commented Dec 25, 2021

To avoid confusion between the names. Any future github issues should use the new names.
However, the commit history should stick to the old names until the rename is implemented, after which it should switch.

@Emoun
Copy link
Owner Author

Emoun commented Dec 26, 2021

Implemented awaiting next release

@Emoun Emoun closed this as completed Dec 26, 2021
@Emoun Emoun mentioned this issue Dec 26, 2021
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-accepted A decision (D) has been made and the issue will be worked on I-feature This issue (I) regards a (potential) feature in the project T-accepted Triage (T): Initial review accepted issue/PR as valid
Projects
None yet
Development

No branches or pull requests

1 participant