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

feat: comments that can be skipped in a file at once #491

Merged
merged 1 commit into from
Aug 8, 2022

Conversation

Javakky-pxv
Copy link
Collaborator

Created based on discussion of #469

You can completely ignore the file by placing ### SkipFileForDocs ### at the beginning of the file like this.

### SkipFileForDocs ###

GET      /api/hidden/a                 controllers.hiddenEndPointA()
GET      /api/hidden/b                 controllers.hiddenEndPointB()
GET      /api/hidden/c                 controllers.hiddenEndPointC()

Looking at SBTSubProjects, the routes file splitting seemed to be a feature for subprojects, but it actually works, so it may be useful for semantic file splitting.

/conf/routes:

GET /index                  controllers.Application.index()

->  /admin admin.Routes

GET     /assets/*file       controllers.Assets.at(path="/public", file)

/conf/admin.routes

GET /index                  controllers.admin.Application.index()

GET /assets/*file           controllers.admin.Assets.at(path="/public/lib/myadmin", file)


case (l @ Failure(_), _) ⇒ l
lines.headOption match {
case Some("### SkipFileForDocs ###") => Success { ListMap.empty }
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If the keyword is at the beginning of the file, it is not read in the first place.

@Javakky-pxv
Copy link
Collaborator Author

@kailuowang
Please, review 🙏

@Javakky-pxv
Copy link
Collaborator Author

@kailuowang
I understand you are very busy, but I deeply desire a review of this PR and the release of a version that includes everything.
If you are unable to work on it for the time being, it would be greatly appreciated if you could let us know when you expect to be able to start work on it.

@Javakky-pxv
Copy link
Collaborator Author

@kailuowang
Thanks

@Javakky-pxv Javakky-pxv merged commit f7b79a2 into master Aug 8, 2022
@kailuowang
Copy link
Collaborator

Sorry I was travelling on my vacation last 3 weeks. Just got back home. This looks great! Thanks so much!

@Javakky-pxv
Copy link
Collaborator Author

@kailuowang
By the way, how do I know that a new version has been released?

@kailuowang
Copy link
Collaborator

kailuowang commented Aug 8, 2022 via email

@Javakky-pxv
Copy link
Collaborator Author

@kailuowang
This method is not yet available for my project because of the pending implementation of play-swagger, but I would like to use it in the future.

@Javakky-pxv Javakky-pxv mentioned this pull request Aug 9, 2022
@Javakky-pxv Javakky-pxv mentioned this pull request Jul 20, 2023
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 this pull request may close these issues.

2 participants