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 improvements before release #52

Closed
21 tasks done
janvonrickenbach opened this issue Jan 12, 2023 · 0 comments · Fixed by #145
Closed
21 tasks done

Documentation improvements before release #52

janvonrickenbach opened this issue Jan 12, 2023 · 0 comments · Fixed by #145
Assignees
Milestone

Comments

@janvonrickenbach
Copy link
Contributor

janvonrickenbach commented Jan 12, 2023

  • Finish getting started

    • Add documentation on how to run local server from installer
  • Rename Objects and Helpers

    • Use different subgroups or use more descriptive name.
  • pyDPF Composite shows up twice in the header because the developer's guide is named like that.

  • Mention operator type in get_dpf_material_id_by_analyis_ply_map

  • Mention operator return type in add_layup_info_to_mesh and better document composite_definition_label. Mention that layup operator is returned.

  • get_constant_property: Mention how materials provider operator can be obtained.

  • Mention corresponding example in API docs of Material Properties.

  • CompositeModel: Replace self by class name. Mention assembly example in docstring. Document arguments of init properly.

  • Show enum values in docs (spots...)

  • Make sure available material properties are shown in docs

  • Document ContinuousFiberCompositeFiles.composite

  • In LayupPropertiesProvider: Mention how layup_provider can be obtained.

  • API docs: Think about order. Make it alphabetical or move most important items to the top.

  • Sort the examples by increasing complexity

  • Examples: Replace get_combined_failiure_criterion function by variable assignment.

  • Go through examples and fix minor typos and wrong cell labels.

  • Don't use strings to instanciate dpf core operators

Optional:

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 a pull request may close this issue.

1 participant