Skip to content
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

Document SubstitutionString #26497

Closed
nalimilan opened this issue Mar 16, 2018 · 1 comment
Closed

Document SubstitutionString #26497

nalimilan opened this issue Mar 16, 2018 · 1 comment
Labels
domain:docs This change adds or pertains to documentation domain:strings "Strings!" good first issue Indicates a good issue for first-time contributors to Julia

Comments

@nalimilan
Copy link
Member

This has been noted on StackOverflow. The replace docstring mentions SubstitutionString, but this type is not exported, not documented, and there's no example. Only the manual explains its use, and without mentioning the type.

We should probably add:

  • a docstring for SubstitutionString
  • a link from replace to the above docstring
  • examples of use

Maybe the type should be exported too?
@nalimilan nalimilan added domain:docs This change adds or pertains to documentation domain:strings "Strings!" labels Mar 16, 2018
@fredrikekre fredrikekre added the good first issue Indicates a good issue for first-time contributors to Julia label Mar 16, 2018
This was referenced May 16, 2018
Closed
Merged
@digital-carver
Copy link
Contributor

Hi @nalimilan , I've added some docs and made a pull request (#27134), could you take a look and let me know if it fits the bill?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
domain:docs This change adds or pertains to documentation domain:strings "Strings!" good first issue Indicates a good issue for first-time contributors to Julia
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@digital-carver @nalimilan @fredrikekre