Skip to content

correct errors in documentation #1581

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

Merged
merged 5 commits into from
Jul 15, 2021
Merged

correct errors in documentation #1581

merged 5 commits into from
Jul 15, 2021

Conversation

stephengold
Copy link
Member

This is mostly for typos in Java comments.

@stephengold stephengold added the Documentation Issues that affect the Wiki, Javadoc or any other form of documentation label Jul 6, 2021
@capdevon
Copy link
Contributor

capdevon commented Jul 7, 2021

Hi Stephen, great job as always!
There would also be the names of these two methods, in the MotionPath class, which start with a capital letter and do not follow the rules of the coding conventions of the java language.

https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-core/src/main/java/com/jme3/cinematic/MotionPath.java#L148

private Geometry CreateLinearPath() { ... }

https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-core/src/main/java/com/jme3/cinematic/MotionPath.java#L158

private Geometry CreateCatmullRomPath() { ... }

There should be no problem correcting them to lowercase, as the two methods are private.

@stephengold
Copy link
Member Author

You're right that those 2 methods should be renamed. However, it should be a separate PR.

@capdevon
Copy link
Contributor

capdevon commented Jul 9, 2021

Ok, I've opened a new issue. #1587

@stephengold stephengold added this to the Future Release milestone Jul 9, 2021
@stephengold stephengold merged commit 52568d7 into master Jul 15, 2021
@stephengold stephengold deleted the sgold-shader-typos branch July 15, 2021 01:21
@stephengold stephengold modified the milestones: Future Release, v3.5.0 Oct 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues that affect the Wiki, Javadoc or any other form of documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants