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.

Sign up for GitHub

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

Jump to bottom

Fix incorrect numpy doc section #1195

Open
Tracked by #1210
wd60622 opened this issue Nov 14, 2024 · 0 comments
Open
Tracked by #1210

Fix incorrect numpy doc section #1195

wd60622 opened this issue Nov 14, 2024 · 0 comments
Labels
docs Improvements or additions to documentation good first issue Good for newcomers

Comments

@wd60622
Copy link
Contributor

wd60622 commented Nov 14, 2024 •
edited
Loading

Remove the "Attributes Set" for "Attributes"

Happens here:

pymc-marketing/pymc_marketing/mmm/mmm.py

Lines 363 to 366 in fa44cc7

Attributes Set
---------------
model : pm.Model
The PyMC model object containing all the defined stochastic and deterministic variables.

Log from the doc build 
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Parameter in the docstring of __init__ in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pydantic/validate_call_decorator.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: potentially wrong underline length...
Attributes Set
--------------- in
Build a probabilistic model using PyMC for marketing mix modeling.
... in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Attributes Set in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Example in the docstring of preprocess in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/base.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Parameter in the docstring of __init__ in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pydantic/validate_call_decorator.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: potentially wrong underline length...
Attributes Set
--------------- in
Build a probabilistic model using PyMC for marketing mix modeling.
... in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Attributes Set in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Example in the docstring of preprocess in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/base.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Parameter in the docstring of __init__ in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pydantic/validate_call_decorator.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: potentially wrong underline length...
Attributes Set
--------------- in
Build a probabilistic model using PyMC for marketing mix modeling.
... in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Attributes Set in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Example in the docstring of format_recovered_transformation_parameters in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Example in the docstring of preprocess in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/base.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Parameter in the docstring of __init__ in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pydantic/validate_call_decorator.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: potentially wrong underline length...
Attributes Set
--------------- in
Build a probabilistic model using PyMC for marketing mix modeling.
... in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Attributes Set in the docstring of build_model in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Example in the docstring of format_recovered_transformation_parameters in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/mmm.py.
  warn(msg)
/home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/numpydoc/docscrape.py:456: UserWarning: Unknown section Example in the docstring of preprocess in /home/wdean/micromamba/envs/pymc-marketing-dev/lib/python3.10/site-packages/pymc_marketing/mmm/base.py.
  warn(msg)
@wd60622 wd60622 added docs Improvements or additions to documentation good first issue Good for newcomers and removed Needs Triage labels Nov 14, 2024
@wd60622 wd60622 mentioned this issue Nov 14, 2024
Open
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wd60622