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.

Sign up for GitHub

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

Jump to bottom

Update tutorial.md on links about "entry point" and "plugin" #6095

Merged
merged 12 commits into from
Aug 19, 2023
Merged

Update tutorial.md on links about "entry point" and "plugin" #6095

merged 12 commits into from
Aug 19, 2023

Conversation

Clarkszw
Copy link
Contributor

@Clarkszw Clarkszw commented Aug 8, 2023 •
edited
Loading

@Clarkszw Clarkszw mentioned this pull request Aug 8, 2023
Open
unkcpz
unkcpz requested changes Aug 12, 2023
View reviewed changes
Copy link
Member

@unkcpz unkcpz left a comment

Choose a reason for hiding this comment

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

Thanks @Clarkszw I have some minor requests. But I have to admit I also not very satisfied with my expression 😬 Better have others have another eye on it.

docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
@unkcpz unkcpz requested a review from edan-bainglass August 12, 2023 00:22
unkcpz
unkcpz requested changes Aug 12, 2023
View reviewed changes
docs/source/intro/tutorial.md Outdated Show resolved Hide resolved
@ltalirz @unkcpz
Apply suggestions from code review
f0d1dd8 
Co-authored-by: Jusong Yu <jusong.yeu@gmail.com>
ltalirz
ltalirz reviewed Aug 12, 2023
View reviewed changes
docs/source/intro/tutorial.md Outdated
These are ideal for workflows that are not very computationally intensive and can be easily implemented in a Python function.
:::

Let's run the `WorkChain` above!

:::{note}
To simplify the basic tutorial, we have left out the steps to register the `MultiplyAddWorkChain` as a plugin which allows us to access the class through the [*entry point*](https://aiida.readthedocs.io/projects/aiida-core/en/latest/topics/plugins.html#topics-plugins-entrypoints) named `core.arithmetic.multiply_add`.
Copy link
Member

@ltalirz ltalirz Aug 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

This is adding the information twice. I would suggest to remove this entire note and mention entry points only after they are used (below)

ltalirz
ltalirz suggested changes Aug 12, 2023
View reviewed changes
Copy link
Member

@ltalirz ltalirz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

thanks @Clarkszw :-) !

I've made some changes, incorporating suggestions from @unkcpz ; from my side it looks good now.

Could you please replace the internal links with references (just have a look at other references on how to do this). Thanks!

@Clarkszw
Copy link
Contributor Author

Clarkszw commented Aug 13, 2023 •
edited
Loading

Thanks @unkcpz and @ltalirz for reviewing.

Could you please replace the internal links with references (just have a look at other references on how to do this). Thanks!

Yes, would love to do. But could you explain me about 'replacing the internal links with references'?
Do you mean the # after the link? (I think they have). Or other reference section that I can update?

@ltalirz ltalirz self-requested a review August 14, 2023 12:21
ltalirz
ltalirz approved these changes Aug 14, 2023
View reviewed changes
Copy link
Member

@ltalirz ltalirz left a comment

Choose a reason for hiding this comment

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

Looks good to me now

@ltalirz ltalirz merged commit 517ffcb into aiidateam:main Aug 19, 2023
@Clarkszw Clarkszw deleted the intro_add_entry_point branch August 21, 2023 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@unkcpz unkcpz unkcpz requested changes

@ltalirz ltalirz ltalirz approved these changes

@edan-bainglass edan-bainglass Awaiting requested review from edan-bainglass

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Clarkszw @ltalirz @unkcpz