Scala3doc: Added filters for default keywords #10155
Conversation
There was a problem hiding this comment.
Hello, and thank you for opening this PR! 🎉
All contributors have signed the CLA, thank you! ❤️
Commit Messages
We want to keep history, but for that to actually be useful we have
some rules on how to format our commit messages (relevant xkcd).
Please stick to these guidelines for commit messages:
- Separate subject from body with a blank line
- When fixing an issue, start your commit message with
Fix #<ISSUE-NBR>:- Limit the subject line to 72 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line ("Add" instead of "Added")
- Wrap the body at 80 characters
- Use the body to explain what and why vs. how
adapted from https://chris.beams.io/posts/git-commit
Have an awesome day! ☀️
grzegorz-bielski
force-pushed
the
scala3doc/btns-for-default-values
branch
5 times, most recently
from
3526045 to
c1edd88
Compare
scala3doc/README.md
Outdated
| project scala3doc | ||
| ``` | ||
|
|
||
| When in the `scala3doc` project in `sbt`, use the following commands to generate documentation for this project and for Dotty, respectively: |
There was a problem hiding this comment.
Imho we should suggest using:
scala3doc/generateSelfDocumentation
scala3doc/generateScala3Documentation
|
I think @TheElectronWill shoudl take a look as well. |
| isElementVisible(elementData, filter) { | ||
| if (!this._areFiltersFromElementSelected(elementData, filter)) { | ||
| return false; | ||
| return !areFiltersFromElementSelected() |
There was a problem hiding this comment.
nitpicking: I'm not a fan of negative ternary conditions when unnecessary - Otherwise LGTM 😃
There was a problem hiding this comment.
I'm planning on streamlining the logic after adding some integration tests - this is more complicated that it should be, not only here, but for now - it works. ^^
There was a problem hiding this comment.
ok! if it works now and will be streamlined later then all good, we can merge as soon as the tests finish
|
@romanowski, @TheElectronWill I added tests |
|
Is something wrong with the check pipelines ? 🤔 |
grzegorz-bielski
force-pushed
the
scala3doc/btns-for-default-values
branch
from
1712491 to
8ecdcca
Compare
|
@TheElectronWill I tried rebasing on top of newest master - it didn't help. Also seems like collaborators are getting a different set of PR checks than non-collaborators. I see that we have the same issue here as well: #10170 |
romanowski
force-pushed
the
scala3doc/btns-for-default-values
branch
from
8ecdcca to
2ca6b36
Compare
|
@grzegorz-bielski this was caused by our config for CI for scala3doc only changes. Now, we've changed it so all tests will be run. I've updated your PR (change hash on last commit) to retrigger all the tests |
romanowski
force-pushed
the
scala3doc/btns-for-default-values
branch
from
2ca6b36 to
5f7d2b8
Compare
scala3docis inserting data into HTML in form of adataattribute for keywords such asoverride,lazy.etc. Based on that we are building the UI component for filtering by those criteria. The said component didn't support filtering by values that are missing special data keywords.I'm not sure if there is any ticket for that. Pinging @romanowski
Main change
Extras
scala3docREADME