Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

Boundary annotation can't deal with parameters with more than one allowed datatype #36

Closed
GideonKoenig opened this issue Jun 24, 2022 · 1 comment · Fixed by #111
Closed

Boundary annotation can't deal with parameters with more than one allowed datatype #36

GideonKoenig opened this issue Jun 24, 2022 · 1 comment · Fixed by #111
Labels
@boundary Related to the @boundary annotation enhancement 💡 New feature or request missing annotation An annotation should have been generated automatically but wasn't wrong annotation An annotation was generated automatically but is incorrect

Comments

@GideonKoenig
Copy link
Contributor

GideonKoenig commented Jun 24, 2022 •
edited
Loading

Describe the bug

Currently there are for example parameters of type (int, float, none), that have a interval specified for if the value is a float, but not, if it's a int.

To Reproduce

#/sklearn/sklearn.ensemble._forest/RandomForestClassifier/__init__/max_samples
Here a boundary annotations is automatically generated, even though the interval is only valid for floats.

Expected behavior

A boundary annotation should be defined for a specific datatype and should only be applied if the provided value is of that type. This way you can have multiple boundaries for different datatypes like float and int and also allow for none or any other type to exist as possible parameter value type next to the one, the boundary applies to.

Screenshots (optional)

Screenshot from 2022-06-24 16-29-48

Additional Context (optional)

No response
@GideonKoenig GideonKoenig added the bug 🪲 Something isn't working label Jun 24, 2022
@GideonKoenig GideonKoenig mentioned this issue Jun 24, 2022
Closed
@lars-reimann lars-reimann added @boundary Related to the @boundary annotation wrong annotation An annotation was generated automatically but is incorrect labels Jun 25, 2022
@lars-reimann lars-reimann mentioned this issue Jul 1, 2022
Closed
@GideonKoenig GideonKoenig changed the title Boundary annotation gets set even when the provided interval is only valid for one allowed datatype Boundary annotation can't deal with parameters with more than one allowed type Jul 1, 2022
@GideonKoenig GideonKoenig changed the title Boundary annotation can't deal with parameters with more than one allowed type Boundary annotation can't deal with parameters with more than one allowed datatype Jul 1, 2022
@GideonKoenig GideonKoenig added enhancement 💡 New feature or request missing annotation An annotation should have been generated automatically but wasn't and removed bug 🪲 Something isn't working labels Jul 1, 2022
@Aclrian
Copy link
Contributor

Aclrian commented Jul 1, 2022

Similar at #/sklearn/sklearn.cluster._optics/OPTICS/__init__/min_cluster_size where the boundary for int is >1 and for float between 0 and 1.

@lukarade lukarade mentioned this issue Jul 1, 2022
Open
@lars-reimann lars-reimann mentioned this issue Mar 19, 2023
Open
11 tasks
@lars-reimann lars-reimann transferred this issue from Safe-DS/API-Editor Mar 19, 2023
@nvollroth nvollroth mentioned this issue May 5, 2023
Merged
lars-reimann added a commit that referenced this issue May 5, 2023
@nvollroth @megalinter-bot @lars-reimann
feat: extraction of boundary types from various docstrings (#111)
9ef79da 
Closes #48, closes #36, closes #35, closes #32, closes #31, closes #30,
closes #27, closes #8.
 

### Summary of Changes

SpaCy rules were generated to recognize named examples and extract the
resulting boundaries.

### Instructions for Manual Testing (if required)

1. Run `pytest` for `test_extract_boundary_values.py`.
2. Check the results of `pytest`.

---------

Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
Co-authored-by: Lars Reimann <mail@larsreimann.com>
@github-project-automation github-project-automation bot moved this from Backlog to ✔️ Done in Library Analysis May 5, 2023
lars-reimann pushed a commit that referenced this issue Jun 1, 2024
@dependabot
build(deps-dev): bump mkdocs-glightbox from 0.3.7 to 0.4.0 (#276)
c52774f 
Bumps [mkdocs-glightbox](https://github.com/Blueswen/mkdocs-glightbox)
from 0.3.7 to 0.4.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Blueswen/mkdocs-glightbox/releases">mkdocs-glightbox's
releases</a>.</em></p>
<blockquote>
<h2>mkdocs-glightbox-0.4.0</h2>
<ul>
<li>Supported manual mode (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/29">#29</a>)</li>
<li>Allow calling lightbox methods from other places (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/34">#34</a>)</li>
<li>Added id to appended script tag (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/38">#38</a>)</li>
<li>Access theme attribute directly (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/40">#40</a>)</li>
<li>Better JavaScript Error Handling (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/36">#36</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/blueswen/mkdocs-glightbox/blob/main/CHANGELOG">mkdocs-glightbox's
changelog</a>.</em></p>
<blockquote>
<p>mkdocs-glightbox-0.4.0 (2023-05-06)</p>
<pre><code>* Supported manual mode
([#29](blueswen/mkdocs-glightbox#29))
* Allow calling lightbox methods from other places
([#34](blueswen/mkdocs-glightbox#34))
* Added id to appended script tag
([#38](blueswen/mkdocs-glightbox#38))
* Access theme attribute directly
([#40](blueswen/mkdocs-glightbox#40))
* Better JavaScript Error Handling
([#36](blueswen/mkdocs-glightbox#36))
</code></pre>
<p>mkdocs-glightbox-0.3.7 (2023-01-24)</p>
<pre><code>* Supported custom background and shadow
([#27](blueswen/mkdocs-glightbox#27))
</code></pre>
<p>mkdocs-glightbox-0.3.6 (2023-12-30)</p>
<pre><code>* Modified width default to auto prevent zooming large image
bug ([#21](blueswen/mkdocs-glightbox#21))
* Supported only enable glightbox with on-glb class in given page
([#28](blueswen/mkdocs-glightbox#28))
</code></pre>
<p>mkdocs-glightbox-0.3.5 (2023-11-18)</p>
<pre><code>* Supported compatibility with the privacy plugin of Material
for MkDocs insiders
([#25](blueswen/mkdocs-glightbox#25))
</code></pre>
<p>mkdocs-glightbox-0.3.4 (2023-04-25)</p>
<pre><code>* Fixed regex bug: quote issue and empty alt issue
([#14](blueswen/mkdocs-glightbox#14)
[#19](blueswen/mkdocs-glightbox#19))
</code></pre>
<p>mkdocs-glightbox-0.3.3 (2023-04-20)</p>
<pre><code>* Refactored processing logic with regex
([#14](blueswen/mkdocs-glightbox#14))
</code></pre>
<p>mkdocs-glightbox-0.3.2 (2023-03-19)</p>
<pre><code>* Supported image without extension
([#13](blueswen/mkdocs-glightbox#13))
</code></pre>
<p>mkdocs-glightbox-0.3.1 (2022-11-22)</p>
<pre><code>* Supported lightbox slide effect customization
([#8](blueswen/mkdocs-glightbox#8))
* Supported synchronized lightbox caption dark mode with Material for
MkDocs ([#7](blueswen/mkdocs-glightbox#7))
* Supported glightbox built-in gallery feature
([#11](blueswen/mkdocs-glightbox#11))
* Supported skip image in the anchor tag
</code></pre>
<p>mkdocs-glightbox-0.3.0 (2022-09-29)</p>
<pre><code>* Fixed width and height setting in config not working bug
* Supported specific skip class
([#5](blueswen/mkdocs-glightbox#5))
* Supported glightbox built-in caption with title and description
([#4](blueswen/mkdocs-glightbox#4))
* Fixed page jitter when lightbox closing issue using Material for
MkDocs
* Add white background for lightbox images to prevent the displaying
issue of the transparent image on black background
</code></pre>
<p>mkdocs-glightbox-0.2.1 (2022-08-10)</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/7f68f19556c8d91eb45bed2f5e3b93f9d0b4e591"><code>7f68f19</code></a>
v0.4.0</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/1409b0de89bd0aa930bbee0c2aa801c8b3391137"><code>1409b0d</code></a>
Add manual mode</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/e5ce7c9214f2de3647cbb1c9a1ec67bd82b387f9"><code>e5ce7c9</code></a>
Add search plugin note</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/d7747e7e1e58e8fe5868f38292bbb6a65f5ac902"><code>d7747e7</code></a>
Merge pull request <a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/29">#29</a>
from michalfapso/main</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/6895d4eb60ef383530f8a807bec19404342a74c3"><code>6895d4e</code></a>
Add test case</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/dc38a6c042da9dcf949a594940f312cfbf5cc1ae"><code>dc38a6c</code></a>
try catch prevent Uncaught TypeError (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/36">#36</a>)</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/7d2c0ab4b214759f7ab22ab9e775c609718ad061"><code>7d2c0ab</code></a>
access theme attribute directly (<a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/40">#40</a>)</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/b0b63f8fa2bfbd14812c95b466af180e34db2cc4"><code>b0b63f8</code></a>
Merge pull request <a
href="https://github.com/Blueswen/mkdocs-glightbox/issues/34">#34</a>
from AndBondStyle/main</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/8e652652429851d18a0c920ca1ddcbf12ab71fdf"><code>8e65265</code></a>
update validation condition</li>
<li><a
href="https://github.com/blueswen/mkdocs-glightbox/commit/4963fdb93c4f483827bcab10c5289452068e1fb5"><code>4963fdb</code></a>
Merge branch 'main' into main</li>
<li>Additional commits viewable in <a
href="https://github.com/Blueswen/mkdocs-glightbox/compare/v0.3.7...v0.4.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocs-glightbox&package-manager=pip&previous-version=0.3.7&new-version=0.4.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
@boundary Related to the @boundary annotation enhancement 💡 New feature or request missing annotation An annotation should have been generated automatically but wasn't wrong annotation An annotation was generated automatically but is incorrect
Projects
Library Analysis
Status: ✔️ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: extraction of boundary types from various docstrings Safe-DS/Library-Analyzer
3 participants
@lars-reimann @Aclrian @GideonKoenig