Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

Update links in initializers documentation #5317

Merged
merged 4 commits into from
Jul 20, 2021

Conversation

himkt
Copy link
Contributor

@himkt himkt commented Jul 18, 2021

I found some links in the initializer documentation were broken.
This PR updates them to fix.

Before submitting

  • I've read and followed all steps in the Making a pull request
    section of the CONTRIBUTING docs.
  • I've updated or added any relevant docstrings following the syntax described in the
    Writing docstrings section of the CONTRIBUTING docs.
  • If this PR fixes a bug, I've added a test that will fail without my fix.
  • If this PR adds a new feature, I've added tests that sufficiently cover my new functionality.

After submitting

  • All GitHub Actions jobs for my pull request have passed.
  • codecov/patch reports high test coverage (at least 90%).
    You can find this under the "Actions" tab of the pull request once the other checks have finished.

* ["constant"](https://pytorch.org/docs/master/nn.init.html?highlight=orthogonal#torch.nn.init.constant_)
* ["eye"](https://pytorch.org/docs/master/nn.init.html?highlight=orthogonal#torch.nn.init.eye_)
* ["dirac"](https://pytorch.org/docs/master/nn.init.html?highlight=orthogonal#torch.nn.init.dirac_)
* ["xavier_uniform"](https://pytorch.org/docs/master/nn.init.html?highlight=orthogonal#torch.nn.init.xavier_uniform_)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The length of the line exceeds 115... 💭

Copy link
Member

@epwalsh epwalsh Jul 19, 2021

Choose a reason for hiding this comment

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

You could just add a # noqa: E501 comment to the end of this docstring. For example, see

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It makes sense! I added the comment in e565dcf.

Copy link
Member

@epwalsh epwalsh left a comment

Choose a reason for hiding this comment

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

LGTM other than the linting issue!

@himkt himkt force-pushed the bugfix/broken-link branch from c564e2a to e565dcf Compare July 20, 2021 09:41
@himkt himkt force-pushed the bugfix/broken-link branch from e565dcf to 58f0bdc Compare July 20, 2021 10:42
Copy link
Member

@epwalsh epwalsh left a comment

Choose a reason for hiding this comment

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

Thanks @himkt!

@epwalsh epwalsh enabled auto-merge (squash) July 20, 2021 15:31
@epwalsh epwalsh merged commit 5b1da90 into allenai:main Jul 20, 2021
@himkt himkt deleted the bugfix/broken-link branch July 20, 2021 18:41
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants