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

Documentation outdated #77

Open
fandreuz opened this issue Jul 24, 2021 · 0 comments
Open

Documentation outdated #77

fandreuz opened this issue Jul 24, 2021 · 0 comments

Comments

@fandreuz
Copy link
Member

It looks like the documentation has not been updated to match the last modifications. The docstrings are updated:

BladeX/bladex/blade.py

Lines 930 to 972 in 905eb8f

def generate_stl(self, upper_face=None,
lower_face=None,
tip=None,
root=None,
max_deg=1,
display=False,
errors=None):
"""
Generate and export the .STL files for upper face, lower face, tip
and root. This method requires PythonOCC (7.4.0) to be installed.
:param string upper_face: if string is passed then the method generates
the blade upper surface using the BRepOffsetAPI_ThruSections
algorithm, then exports the generated CAD into .stl file holding
the name <upper_face_string>.stl. Default value is None
:param string lower_face: if string is passed then the method generates
the blade lower surface using the BRepOffsetAPI_ThruSections
algorithm, then exports the generated CAD into .stl file holding
the name <lower_face_string>.stl. Default value is None
:param string tip: if string is passed then the method generates
the blade tip using the BRepOffsetAPI_ThruSections algorithm
in order to close the blade at the tip, then exports the generated
CAD into .stl file holding the name <tip_string>.stl.
Default value is None
:param string root: if string is passed then the method generates
the blade root using the BRepOffsetAPI_ThruSections algorithm
in order to close the blade at the root, then exports the generated
CAD into .stl file holding the name <tip_string>.stl.
Default value is None
:param int max_deg: Define the maximal U degree of generated surface.
Default value is 1
:param bool display: if True, then display the generated CAD. Default
value is False
:param string errors: if string is passed then the method writes out
the distances between each discrete point used to construct the
blade and the nearest point on the CAD that is perpendicular to
that point. Default value is None
We note that the blade object must have its radial sections be arranged
in order from the blade root to the blade tip, so that generate_stl
method can build the CAD surface that passes through the corresponding
airfoils. Also to be able to identify and close the blade tip and root.
"""

but the generated HTML file aren't (https://mathlab.github.io/BladeX/_summaries/bladex.blade.Blade.generate_stl.html).

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

No branches or pull requests

1 participant