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

Add option to make RSE team co-author #69

Merged
merged 2 commits into from
Aug 13, 2024
Merged

Add option to make RSE team co-author #69

merged 2 commits into from
Aug 13, 2024

Conversation

alexdewar
Copy link
Collaborator

Currently it's just added by default, which users who aren't part of the RSE team probably won't want.

We do usually want to list the RSE team as a co-author, so I think this is useful for us. That said, it's debateable whether we want another cookiecutter option for it or to just have it commented out in pyproject.toml. I think either way is fine.

Currently it's just added by default, which users who aren't part of the RSE team probably won't want.
@alexdewar alexdewar marked this pull request as ready for review August 7, 2024 09:18
@@ -4,8 +4,10 @@ name = "{{ cookiecutter.project_slug }}"
version = "0.1.0"
description = "{{ cookiecutter.project_description }}"
authors = [
"{{ cookiecutter.author }} <{{ cookiecutter.author_email }}>",
"{{ cookiecutter.author }} <{{ cookiecutter.author_email }}>"
Copy link
Contributor

Choose a reason for hiding this comment

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

I suspect we're going to need a comma here

Suggested change
"{{ cookiecutter.author }} <{{ cookiecutter.author_email }}>"
"{{ cookiecutter.author }} <{{ cookiecutter.author_email }}>",

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We don't actually need a comma, because one's added on the line below.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I see, I did miss that. Won't that format really weirdly? It seems like it will be a single, unindented line with one comma in it? Like:

uthors = [
    "Author <mail@mail.com>"
,
    "Imperial College London RSE Team <ict-rse-team@imperial.ac.uk>"
]

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Weirdly not. If you start your jinja block with <%- rather than just <% it trims the whitespace before it, so you can have it on a new line (similarly if you put -%> at the end it'll trim the whitespace after).

We don't have to do it this way though if you think it's more readable to have the if on the previous line.

Copy link
Contributor

Choose a reason for hiding this comment

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

jinja is weird...

Copy link
Contributor

Choose a reason for hiding this comment

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

We don't have to do it this way though if you think it's more readable to have the if on the previous line.

Sorry, I missed this reply. No, it's not more or less readable, I just saw the if had been removed previously.

@@ -28,8 +30,10 @@ name = "{{ cookiecutter.project_slug }}"
version = "0.1.0"
description = "{{ cookiecutter.project_description }}"
authors = [
{ name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.author_email }}" },
{ name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.author_email }}" }
Copy link
Contributor

Choose a reason for hiding this comment

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

And here

Suggested change
{ name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.author_email }}" }
{ name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.author_email }}" },

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ditto.

Copy link
Contributor

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

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

LGTM

@alexdewar alexdewar enabled auto-merge August 13, 2024 09:21
@alexdewar alexdewar merged commit 7016a0a into main Aug 13, 2024
9 checks passed
@alexdewar alexdewar deleted the rse_team_option branch August 13, 2024 09:30
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