Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Broken documentation GitHub action

See original GitHub issue

As you may already noticed, the “documentation” action is failing (and thus the deployment action).

The action started to fail after merging #241. The error message is far from being helpful in solving the issue.

I have the feeling that this could be related to the new callbacks hierarchy. As of now, the base class StrategyCallbacks, which defines all possible plugin/loggers/metrics callbacks, declares its methods as:

def before_training(self, *args, **kwargs) -> CallbackResult:

while child classes define a different arguments signature (for instance, by adding a mandatory strategy argument and/or by removing the *args and **kwargs ones. I was thinking that maybe the docstring action, in order to create the documentation for the method arguments, expects the child classes to strictly follow the Liskov substitution principle (which is a good thing, in general).

One possible solution is to introduce a different base class for each category (plugin, metric, logger) to adhere to this principle.

I’ll try to test if this is the actual problem. I’ll keep you posted!

@AntonioCarta if my assumption is correct, this would require updating the class hierarchy. I don’t think this should interfere with #226, but keep it under consideration.

Note: using sphinx 3.3.1 everything works fine from my side -_-, so this problem only apply to the latest version.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

lrzpellegrinicommented, Jan 25, 2021

I just successfully tested a fix on my rig. I’m now waiting for actions to complete on my fork. I’m planning to open a PR in the next 10/20 minutes.

lrzpellegrinicommented, Jan 24, 2021

I identified the problem with the astroid package, which is internally used by sphinx. Forcing astroid to version 2.4.2 (latest) via pip fixes the issue. For some reason conda doesn’t seem to pick the latest version of that package. Also works with astroid 2.4.1

Read more comments on GitHub >

github_iconTop Results From Across the Web

Broken Link Checker Action - GitHub Marketplace
GitHub Actions to check broken links and create issues. ... GitHub Actions that detects broken links in a page with a specified URL...
Read more >
broken-link-check · Actions · GitHub Marketplace
Find broken links, missing images, etc within your HTML.
Read more >
Marketplace Actions Broken Web Link Checker - GitHub
Broken Link Checker Action. This action trawls a deployed website and crawls the site looking for broken links before producing a report.
Read more >
Broken-Links-Crawler · Actions · GitHub Marketplace
Broken -Links-Crawler-Action. This action checks all links on a website. It will detect broken links i.e. links that return HTTP Code 403, 404....
Read more >
Use `$GITHUB_OUTPUT` environment file for Broken Doc ...
N/A this affects the GitHub Action workflow for fixing broken ... Use $GITHUB_OUTPUT environment file for Broken Doc Links workflow #21549.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found