Skip to content

Update cookbook titles for docs display - #351

Open
hannahbaumann wants to merge 11 commits into
mainfrom
update-cookbook-titles
Open

hannahbaumann wants to merge 11 commits into
mainfrom
update-cookbook-titles

Conversation

@hannahbaumann

Copy link
Copy Markdown
Contributor

No description provided.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

Colab 👈 Launch a Colab session on branch update-cookbook-titles

@IAlibay IAlibay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One larger question on tense and one smaller nit.

"metadata": {},
"source": [
"# BespokeFit: Using bespoke force field parameters with OpenFE protocols\n",
"# Use bespoke parameters with BespokeFit\n",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I notice you're changing the text away from present participle - is this intentional?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, this was intentional, mostly to shorten titles, and also because if now it's How-to ... it works better I thought. But if others think the other version is better, I can also switch to that.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah I see, so it's "How to X"? That makes a lot of sense, thanks!

Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
@hannahbaumann
hannahbaumann requested a review from IAlibay November 2, 2026 11:56
Comment thread cookbook/loading_molecules.ipynb Resolved
Comment thread cookbook/loading_molecules.ipynb Resolved
Comment thread cookbook/loading_molecules.ipynb Resolved
Comment thread cookbook/loading_molecules.ipynb Resolved
Comment thread cookbook/user_charges.ipynb Resolved
Comment thread cookbook/user_charges.ipynb Resolved
@@ -4,7 +4,7 @@
"cell_type": "markdown",

@jthorton jthorton Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe we could hit part of OpenFreeEnergy/openfe#2283 with this change as well and drop bespokefit from the title? I can then update the introduction in another PR to say BespokeFit is just one example of the input files we can use.

What about "Using custom force field parameters" as a more general title?


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I like the idea of changing the title and the explanation to make it more broad, but I would suggest we can maybe change the title together with the text in a follow up PR?

@@ -5,7 +5,7 @@
"id": "035c0099-6892-4ed2-b0d6-80b1c247c1e7",

@jthorton jthorton Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should it be -> Plan a LigandNetwork to match the use of the AlchemicalNetwork in the other cookbook titles?


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done!

@hannahbaumann hannahbaumann self-assigned this Nov 2, 2026

@IAlibay IAlibay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm thanks

Comment thread cookbook/generate_ligand_network.ipynb Resolved
Comment thread cookbook/ligandnetwork_vis.ipynb Resolved
Comment thread cookbook/network_from_orion_fepp.ipynb Resolved
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
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