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

References in tutorials #401

Closed
3 tasks
purva-thakre opened this issue Dec 30, 2023 · 6 comments · Fixed by #606
Closed
3 tasks

References in tutorials #401

purva-thakre opened this issue Dec 30, 2023 · 6 comments · Fixed by #606
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers non-quantum
Milestone

Comments

@purva-thakre
Copy link
Collaborator

purva-thakre commented Dec 30, 2023

The references in tutorials are manual entries. It would be better to instead make use of the changes introduced in #228.

To close this issue:

  • use articles.bib or books.bib for the tutorials references
  • use appropriate bibtex keys for inline citations in tutorials
  • add a references section at the bottom of each tutorial (files are in docs)

https://chiplicity.readthedocs.io/en/latest/Using_Sphinx/UsingBibTeXCitationsInSphinx.html

https://toqito.readthedocs.io/en/latest/tutorials.html

@purva-thakre purva-thakre added documentation Improvements or additions to documentation good first issue Good for newcomers non-quantum labels Dec 30, 2023
@purva-thakre purva-thakre self-assigned this Apr 8, 2024
@purva-thakre purva-thakre added this to the v1.0.8 milestone Apr 8, 2024
@purva-thakre purva-thakre removed their assignment Apr 8, 2024
@minhduy13ly
Copy link

Hi @purva-thakre, this is the first time I am joining the open-source work, so I happy to learning and contributing on this tasks. Could you please help to assign it for me?
Also, I have the clarify question? Is the article in the articles.bib is for reference tutorial or not or this is belong to another purpose?
Thank you very much

@vprusso
Copy link
Owner

vprusso commented May 29, 2024

Hi @minhduy13ly ,

Thank you for your interest in this issue, and welcome to open-source :)

To answer your question, the articles.bib file is a LaTeX bibliography file that contains the references used throughout the toqito project. These references are cited throughout the toqito project.

Does this answer your question?

@purva-thakre
Copy link
Collaborator Author

@minhduy13ly In addition to what Vincent said, feel free to work on this issue and create a PR for it.

If you are completely new to Github in addition to open source projects, this link might be useful. Feel free to ask us any questions related to this.

Due to UnitaryHACK rules, you won't be assigned an issue until you have successfully completed it.

@minhduy13ly
Copy link

Sure, I am clear now. Many thanks @purva-thakre @vprusso

@purva-thakre
Copy link
Collaborator Author

purva-thakre commented May 31, 2024

HI @minhduy13ly, looks like this issue is going to be successfully closed by someone else. We still have additional bountied issues open. Let us know if you require help with the open issues.

@Roshan-Thomas
Copy link
Contributor

Commenting here for closing the issue #401. The pull request for that is #606. Cheers :)

purva-thakre pushed a commit that referenced this issue May 31, 2024
* References in tutorials added. Also, missing article references were also added to articles.bib

* Resolving alphabetical ordering of articles in articles.bib
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers non-quantum
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants