Fix path of /docs/ [ci skip] #6075
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #6075 +/- ##
==========================================
Coverage 69.78% 69.79%
- Complexity 17357 17358 +1
==========================================
Files 1962 1962
Lines 74357 74357
Branches 7623 7623
==========================================
+ Hits 51893 51895 +2
+ Misses 19820 19819 -1
+ Partials 2644 2643 -1 ☔ View full report in Codecov by Sentry. |
|
I added a commit to fix one last mention that I forgot before |
| @@ -14,7 +14,7 @@ public interface DocsTestConstants { | |||
| File USER_DOC_PATH = new File(DOC_ROOT, "user"); | |||
|
|
|||
| /** | |||
| * This method return {@code true} if the /docs directory is available. If not, a warning is | |||
| * This method return {@code true} if the /doc directory is available. If not, a warning is | |||
There was a problem hiding this comment.
This should probably say /doc/user right? At least that is the path that the code is looking at.
| @@ -24,7 +24,7 @@ static boolean docsExistOrWarn() { | |||
| } | |||
| LOG.warn( | |||
| """ | |||
| SKIP TEST - '/docs' NOT FOUND | |||
| SKIP TEST - '/doc' NOT FOUND | |||
There was a problem hiding this comment.
/doc/user here as well
There was a problem hiding this comment.
Yeah you're right. But what about the warn string just below in the LOG.warn?
The doc/templates directory might not be available if you run the tests outside the root of the projects. This may happen if the project root is not the working directory, if you run tests using jar files or in a Maven multi-module project.
Shouldn't we check also if the doc/template directory exist? And change the comment accordingly quoting both doc/user and doc/templates.
Summary
Fix the wrong mentions of the documentation folder which changed from /docs to /doc/user and in the function comments from /docs to /doc