Skip to content

RFC: Add cross references in subset related operator's docs. #39750

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Apr 3, 2021
Merged

RFC: Add cross references in subset related operator's docs. #39750

merged 5 commits into from
Apr 3, 2021

Conversation

@AtsushiSakai
Copy link
Contributor

@AtsushiSakai AtsushiSakai commented Feb 19, 2021

I added cross references in subset related operator's docs to fix #22639.
I think adding cross references is a good idea to allows us to find the desired function easily.

@ViralBShah ViralBShah added the docs This change adds or pertains to documentation label Feb 19, 2021
@AtsushiSakai AtsushiSakai changed the title Add cross references in subset related operator's docs. RFC: Add cross references in subset related operator's docs. Feb 23, 2021
bicycle1885
bicycle1885 suggested changes Mar 14, 2021
View reviewed changes
Copy link
Member

@bicycle1885 bicycle1885 left a comment

Choose a reason for hiding this comment

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

I think it would be better to quote operators in docstring.

mcabbott
mcabbott reviewed Mar 14, 2021
View reviewed changes
@AtsushiSakai
Copy link
Contributor Author

AtsushiSakai commented Mar 22, 2021

I addressed all review comments. The CI failures looks like unrelated this PR change:

Error in testset cmdlineargs:
Error During Test at /buildworker/worker/tester_linux32/build/share/julia/test/cmdlineargs.jl:209
  Test threw exception
  Expression: read(`$exename -t $cpu_threads -e $code`, String) == string(cpu_threads)
  failed process: Process(`/buildworker/worker/tester_linux32/build/bin/julia -Cnative -J/buildworker/worker/tester_linux32/build/lib/julia/sys.so --depwarn=error --check-bounds=yes -g1 --startup-file=no --startup-file=no --color=no -t 256 -e 'print(Threads.nthreads())'`, ProcessSignaled(11)) [0]

@simeonschaub simeonschaub reopened this Apr 3, 2021
@simeonschaub simeonschaub added the merge me PR is reviewed. Merge when all tests are passing label Apr 3, 2021
@vtjnash vtjnash merged commit 2ee8c87 into JuliaLang:master Apr 3, 2021
@simeonschaub simeonschaub removed the merge me PR is reviewed. Merge when all tests are passing label Apr 3, 2021
@AtsushiSakai AtsushiSakai deleted the issue_22639 branch April 3, 2021 22:13
ElOceanografo pushed a commit to ElOceanografo/julia that referenced this pull request May 4, 2021
@AtsushiSakai @ElOceanografo
doc: add cross references in subset-related operators (JuliaLang#39750)
b6d8fd2
antoine-levitt pushed a commit to antoine-levitt/julia that referenced this pull request May 9, 2021
@AtsushiSakai @antoine-levitt
doc: add cross references in subset-related operators (JuliaLang#39750)
2590d8c
johanmon pushed a commit to johanmon/julia that referenced this pull request Jul 5, 2021
@AtsushiSakai @johanmon
doc: add cross references in subset-related operators (JuliaLang#39750)
d05d081
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@simeonschaub simeonschaub simeonschaub approved these changes

@bicycle1885 bicycle1885 Awaiting requested review from bicycle1885

+1 more reviewer

@mcabbott mcabbott mcabbott left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs This change adds or pertains to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docstrings for issubset and in should have related-but-not-synonymous signatures split out

6 participants

@AtsushiSakai @bicycle1885 @simeonschaub @mcabbott @vtjnash @ViralBShah