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

[BUG] Documentation for pygmo.decomposition_weights has issues #70

Closed
baluyotraf opened this issue Mar 22, 2021 · 7 comments · Fixed by #71
Closed

[BUG] Documentation for pygmo.decomposition_weights has issues #70

baluyotraf opened this issue Mar 22, 2021 · 7 comments · Fixed by #71
Labels
bug Something isn't working

Comments

@baluyotraf
Copy link
Contributor

baluyotraf commented Mar 22, 2021

The description of the arguments for decomposition_weights does not seem to be correct. The raises formatting is also a bit off. I also checked the rst and the docs from the website and the rst seems to agree.

https://esa.github.io/pygmo2/mo_utils.html
https://github.com/esa/pygmo2/blob/master/pygmo/docstrings.cpp

@baluyotraf baluyotraf added the bug Something isn't working label Mar 22, 2021
@bluescarni
Copy link
Member

@baluyotraf thanks for reporting the issue. I can see the problem with the formatting of the raises clause, but can you be more specific about the issue with the documentation of the arguments for decomposition_weights?

Pinging @darioizzo as I am not much familiar with this part of the code.

@baluyotraf
Copy link
Contributor Author

Sure.

method (:class:`str`): the reference point :math:`\mathbf z^*`. It is not used if *method* is ``"weighted"``

Should refer to grid, random, or low_descrepancy

seed (:class:`int`): the decomposition method: one of ``"weighted"``, ``"tchebycheff"`` or ``"bi"``

Mismatched data type, should refer to a seed.

Returns:
    1D NumPy float array:  the weights

The example returns a 2D numpy array.

@bluescarni
Copy link
Member

@baluyotraf ok cheers, thanks for clarifying :)

@baluyotraf
Copy link
Contributor Author

no problem : )

@darioizzo
Copy link
Member

yeps all true .... needs a fix.

@baluyotraf
Copy link
Contributor Author

I can do a quick PR later

@bluescarni
Copy link
Member

@baluyotraf that would be great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants