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

fix: pdoc failure #209

Merged
merged 2 commits into from
Dec 3, 2024
Merged

fix: pdoc failure #209

merged 2 commits into from
Dec 3, 2024

Conversation

cynicaljoy
Copy link
Contributor

Description

Fix for pdoc generator

Motivation and context

  File "/usr/local/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 46, in block 'nav_submodules'
    {% if module.submodules %}
  File "/usr/local/lib/python3.9/site-packages/jinja2/environment.py", line 487, in getattr
    return getattr(obj, attribute)
  File "/usr/local/lib/python3.9/functools.py", line 993, in __get__
    val = self.func(instance)
  File "/usr/local/lib/python3.9/site-packages/pdoc/doc.py", line 478, in submodules
    for mod_name, mod in extract.iter_modules2(self.obj).items():
  File "/usr/local/lib/python3.9/site-packages/pdoc/extract.py", line 256, in iter_modules2
    members = dir(module) if mod_all is None else mod_all
  File "/tmp/build/1a4543b4/fauna-python-repository/./fauna/query/models.py", line 20, in __dir__
    return super.__dir__() + "StreamToken"  # pyright: ignore
TypeError: unbound method object.__dir__() needs an argument

How was the change tested?

Validated using docker container locally to recreate the documentation pipeline task

Screenshots (if appropriate):

Change types

    • Bug fix (non-breaking change that fixes an issue)
    • New feature (non-breaking change that adds functionality)
    • Breaking change (backwards-incompatible fix or feature)

Checklist:

    • My code follows the code style of this project.
    • My change requires a change to Fauna documentation.
    • My change requires a change to the README, and I have updated it accordingly.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

erickpintor
erickpintor previously approved these changes Dec 3, 2024
Copy link
Contributor

@erickpintor erickpintor left a comment

Choose a reason for hiding this comment

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

🐑 it.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Comment LGTM. Thanks for fixing this.

@cynicaljoy cynicaljoy merged commit 62ca060 into main Dec 3, 2024
6 checks passed
@cynicaljoy cynicaljoy deleted the pdoc-error branch December 3, 2024 21:41
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