Fix ProfilerOptions() documentation #996
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacob-buehler
requested review from
ksneab7,
taylorfturner,
micdavis and
tyfarnan
as code owners
taylorfturner
changed the title
taylorfturner
suggested changes
Aug 2, 2023
| @@ -245,7 +245,7 @@ | |||
| "\n", | |||
| "Below, let's remove the histogram and increase the number of samples to the labeler component (1,000 samples). \n", | |||
| "\n", | |||
| "Full list of options in the Profiler section of the [DataProfiler documentation](https://capitalone.github.io/DataProfiler)." | |||
| "Full list of options in the Profiler section of the [DataProfiler documentation](https://capitalone.github.io/DataProfiler/docs/0.10.2/html/profiler.html#profile-options)." | |||
There was a problem hiding this comment.
I'm concerned with this change
There was a problem hiding this comment.
very brittle: because as soon as the version changes, this will break
There was a problem hiding this comment.
just tested and still works with 0.10.1 @jacob-buehler @taylorfturner
There was a problem hiding this comment.
....ah I see what u mean, breaks as in, it'll go stale
There was a problem hiding this comment.
exactly -- goes stale, yes. Not that it breaks in the sense it doesn't go that versions link, but should go to the most up to date / max(version) of the docs
taylorfturner
suggested changes
Aug 2, 2023
| @@ -178,7 +178,7 @@ | |||
| "\n", | |||
| "Below, let's remove the vocab count and set the stop words. \n", | |||
| "\n", | |||
| "Full list of options in the Profiler section of the [DataProfiler documentation](https://capitalone.github.io/DataProfiler)." | |||
| "Full list of options in the Profiler section of the [DataProfiler documentation](https://capitalone.github.io/DataProfiler/docs/0.10.2/html/profiler.html#profile-options)." | |||
|
updated in #1002 |
auto-merge was automatically disabled
August 3, 2023 19:44
Pull request was closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed a bad link.
Issue #689:
The hyperlink in the below sentence in the Profiler options section of the Data Profiler documentation needs to link to better documentation for more in-depth options documentation.