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

[unpleasant] Address Comments on Styles and Improve Citation Style #495

Merged
merged 2 commits into from
Jul 5, 2024

Conversation

HumphreyYang
Copy link
Collaborator

This PR resolves #445.

Copy link

netlify bot commented Jul 1, 2024

Deploy Preview for taupe-gaufre-c4e660 ready!

Name Link
🔨 Latest commit 27e5648
🔍 Latest deploy log https://app.netlify.com/sites/taupe-gaufre-c4e660/deploys/66860c736177dd00083bceac
😎 Deploy Preview https://deploy-preview-495--taupe-gaufre-c4e660.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Jul 1, 2024

@github-actions github-actions bot temporarily deployed to pull request July 1, 2024 13:18 Inactive
@github-actions github-actions bot temporarily deployed to pull request July 1, 2024 13:20 Inactive
@mmcky mmcky self-requested a review July 2, 2024 00:10
Copy link
Contributor

@mmcky mmcky left a comment

Choose a reason for hiding this comment

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

thanks @HumphreyYang this looks great.

The use of cite:t isn't common across our lectures.

Currently we recommend to use cite and have updated the default to use author_year. Does the cite:t provide different formatting?

https://manual.quantecon.org/styleguide/references.html

@HumphreyYang
Copy link
Collaborator Author

HumphreyYang commented Jul 2, 2024

Many thanks @mmcky.

The old version is
Screenshot 7

and the cite:t version is
Screenshot 6

I think cite:t is closer to the citation style we want to use here, but please let me know if I should revert this change.

@mmcky
Copy link
Contributor

mmcky commented Jul 3, 2024

thanks @HumphreyYang this is super interesting.

@jstac if we want to migrate to cite:t we will need to do a bulk edit across all lectures.
Currently we have author_year style set for bibtex and the differences are shown above.

The engineer in me has always liked the reference in brackets [ but cite:t is closer to the usual text representation in economics.

lectures/unpleasant.md Outdated Show resolved Hide resolved
lectures/unpleasant.md Outdated Show resolved Hide resolved
lectures/unpleasant.md Outdated Show resolved Hide resolved
@jstac
Copy link
Contributor

jstac commented Jul 4, 2024

@mmcky @HumphreyYang Regarding cites, that's a tough one. There are cites in other lectures that don't suit this style (should we make a blanket change). See, e.g., https://jax.quantecon.org/aiyagari_jax.html

I'd like to stay out of this if I can 😬

@mmcky
Copy link
Contributor

mmcky commented Jul 4, 2024

@HumphreyYang I think my preference would be to use the global author_year style that uses brackets as it is globally enabled. That will improve consistency.

  • convert cite:t to cite
  • open an issue to document cite:t and we can have a further think about switching styles (in bulk), but for now let's stay uniform in our approach. (#501)

@github-actions github-actions bot temporarily deployed to pull request July 4, 2024 02:50 Inactive
@github-actions github-actions bot temporarily deployed to pull request July 4, 2024 02:51 Inactive
@HumphreyYang
Copy link
Collaborator Author

Hi @mmcky, I have addressed your and @jstac's comments. Please let me know if there is anything else I can further improve.

@mmcky mmcky self-requested a review July 5, 2024 02:11
Copy link
Contributor

@mmcky mmcky left a comment

Choose a reason for hiding this comment

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

thanks @HumphreyYang this looks great.

@mmcky mmcky added the ready label Jul 5, 2024
@jstac
Copy link
Contributor

jstac commented Jul 5, 2024

Many thanks @HumphreyYang .

@jstac jstac merged commit fa99488 into main Jul 5, 2024
7 checks passed
@jstac jstac deleted the update-unpleasant branch July 5, 2024 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[unpleasant] Editorial Suggestions
3 participants