Skip to content

Conversation

@akeeste
Copy link
Contributor

@akeeste akeeste commented Feb 15, 2022

This PR primarily updates the response class API to

  • Better describe the variables contained there and what each refers to.
  • Clarify the orientation of the body forces, e.g. that the output.bodies(#).forceRadiationDamping is actually the negative of the radiation damping force applied to the WEC
  • cables
  • moordyn
  • ptosim

@akeeste akeeste added Documentation related to docs Response Class Response Class (responseClass.m) labels Feb 15, 2022
@kmruehl kmruehl self-requested a review February 16, 2022 15:14
@akeeste akeeste marked this pull request as ready for review February 16, 2022 20:57
@akeeste
Copy link
Contributor Author

akeeste commented Feb 16, 2022

@kmruehl This is ready for review. Can you confirm if the responseClass API is showing cables, moorDyn and PTO-Sim twice? I'm not sure if this is a local issue with my docs build or not.

@kmruehl kmruehl merged commit 91a4535 into WEC-Sim:dev Feb 17, 2022
@kmruehl
Copy link
Collaborator

kmruehl commented Feb 17, 2022

@akeeste merged, up to you if you want to delete the branch

@akeeste akeeste deleted the responseClassDoc branch February 21, 2022 15:17
@akeeste
Copy link
Contributor Author

akeeste commented Feb 21, 2022

@kmruehl It does look like the responseClass API is still duplicating some values (cables, moordyn, ptosim) for some reason. I'll take a look at how to remove these duplicate parameters.

The empty parameters are shown as the last parameters, but the documented ones are listed above (cut off):

image

@kmruehl
Copy link
Collaborator

kmruehl commented Feb 22, 2022

@akeeste you should be able to add those to the excluded parameter in the .rst file. However, I believe this happens because we have the description of the responseClass at the top, but we also create a structure for each of the other classes within the responseClass which is then documented by the API unless we explicitly tell it not to. I do not think it's an issue to have them twice, but I agree it would be cleaner to remove them.

@akeeste akeeste mentioned this pull request Feb 24, 2022
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation related to docs Response Class Response Class (responseClass.m)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants