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

[Documentation] Typos & link fix #259

Merged
merged 2 commits into from
Dec 2, 2023
Merged

Conversation

SimonPop
Copy link
Contributor

@SimonPop SimonPop commented Dec 2, 2023

Hi everyone!

I was reading through the introduction tutorial of the library and could spot minor typos. I decided to try and fix some of them.

At the same time, I updated the internal links to classes and methods when I could.

Here is the list of modifications proposed in this commit:

  • Correcting minor typos.
  • Updating internal links when the path is no longer correct (e.g. torch_frame.TensorFrame -> torch_frame.data.TensorFrame).
  • Including the 's' for plural links into the pastil using a trick described in https://stackoverflow.com/questions/19403972/writing-terms-in-plural-without-the-redundancy (e.g. :class:torch.Tensor\ s -> :class:Tensors<torch.Tensor>).
  • Providing links for existing classes previously unlinked (e.g. :obj:Dataset -> :obj:torch_frame.data.Dataset).

I don't know if tooling exists to maintain documentation when refactoring, but hopefully, this commit can refresh it slightly for now.

Do tell me if you think I have missed something that could be updated in this same commit, or if I did change something that was intended to be as it was.

Thank you for creating this library, I am very enthusiastic about it!

Copy link
Contributor

@weihua916 weihua916 left a comment

Choose a reason for hiding this comment

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

Thank you so much! LGTM.

@weihua916 weihua916 merged commit bcdaa40 into pyg-team:master Dec 2, 2023
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.

2 participants