-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Concise info on creating and using a module without core and base #46628
Conversation
|
I think its fixed. |
Maybe it shouldn't try to test adding docstrings from the REPL (or add a more trivial one)? |
Yeah I've added a more trivial one which shouldn't throw an error. |
I still don't think the |
And I think they're one of the reasons the whitespace is failing as well. I'll remove it now. |
@ViralBShah are you looking at this since you're more active in doc PRs. |
I usually merge the ones that are obvious to me. |
@ViralBShah I certainly do not know what you mean by "obvious" but I feel this discussion 👉#46536 opened here concerning merging stuffs like this is a valid one. You might to check out what I'm talking about. |
Doc PRs touch many different aspects and need to have reviews from appropriate people. Thus, I can only merge the ones that I am sure about - on others I try to find other reviewers. But yes, developer bandwidth continues to be limited, although we try to do our best to stay on top of open PRs. A lot of people have commit access to the repo, but on a given PR there's often only a few people who can authoritatively merge. I am happy to be pinged on such PRs to take a look. |
OK! |
I had a hard time solving this - (using
@eval
to write code into the module and then writing a function doc for the new function evaluated using@eval
).Thank God for the helpful and timely answers I got from slack and discourse, then I finally knew how to use
@eval
on working with functions on the module withoutcore
andbase
.Then finally documenting the function was another series of asking questions and finally the timely answers came. And I could add a function docstring to it.
But the point is, why not just show a quick demo of this in the documentation so others don't have to pass through this stress?