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

Docs update: typos, more references, and updated FF file #223

Merged
merged 2 commits into from
Jun 24, 2024

Conversation

RyanDavies19
Copy link
Collaborator

Fixed typos found and/or reported by users. Aims to clear up common questions seen on OepnFAST help pages. Updates the FAST.Farm example to be consistent with current capabilities. Adds more references to publications about feature improvements.

@sanguinariojoe
Copy link
Collaborator

Hey! This PR will introduce some conflicts on #182.

I suggest the following:

Is that OK?

@@ -108,11 +108,11 @@ moordyn::MoorDyn::MoorDyn(const char* infilename, int log_level)
_basepath = _filepath.substr(0, lastSlash + 1);
}

LOGMSG << "\n Running MoorDyn (v2.0.0, 2023-09-18)" << endl
LOGMSG << "\n Running MoorDyn (v2.3.1, 2024-5-24)" << endl // TODO: can we automate this?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version for sure! The date would be quite annoying... However I think we can just drop it, since we have now automated releases with the timestamp. Everyone can check when do we release a new version

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, as long as the version is up to date users can reference the release.

@RyanDavies19
Copy link
Collaborator Author

@sanguinariojoe that sounds like a good plan. I will have more reg tests up next week for comparison. Let me know if there are any you want to compare.

@sanguinariojoe
Copy link
Collaborator

I have changed my mind... I am merging this, launching a patch release, and then we can continue with the other tasks (verification and time marching)

@sanguinariojoe sanguinariojoe merged commit 3b49bbd into FloatingArrayDesign:dev Jun 24, 2024
6 checks passed
@RyanDavies19 RyanDavies19 deleted the docs_update branch June 24, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants