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.

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

Documentation: replace type with struct and/or mutable struct #28277

Closed
fsaad opened this issue Jul 25, 2018 · 1 comment · Fixed by #28288
Closed

Documentation: replace type with struct and/or mutable struct #28277

fsaad opened this issue Jul 25, 2018 · 1 comment · Fixed by #28288
Labels
domain:docs This change adds or pertains to documentation status:help wanted Indicates that a maintainer wants help on an issue or pull request

Comments

@fsaad
Copy link

fsaad commented Jul 25, 2018

There are a few places in the stable documentation that mention the type keyword (which is gone, #19157), e.g. the phrases "type block" and "type definition block" should be changed to mention struct or mutable struct.

Here are a few of the offending instances that I found in doc/:

/tmp/julia $ git grep '`type`' doc | grep \.md
doc/src/manual/calling-c-and-fortran-code.md:variables will not be visible in Julia unless the type is mutable (declared via `type`). However,
doc/src/manual/constructors.md:`type` block.
doc/src/manual/constructors.md:constructor only for `SummedArray`, but inside the `type` definition block to suppress
doc/src/manual/faq.md:This does not apply to `function` or `type` declarations. However, anonymous functions bound to global
doc/src/manual/noteworthy-differences.md:  * Julia's `type`s do not support dynamically adding fields at runtime, unlike MATLAB's `class`es.
@KristofferC KristofferC added the status:help wanted Indicates that a maintainer wants help on an issue or pull request label Jul 25, 2018
@JeffBezanson JeffBezanson added domain:docs This change adds or pertains to documentation and removed status:help wanted Indicates that a maintainer wants help on an issue or pull request labels Jul 25, 2018
@JeffBezanson
Copy link
Sponsor Member

Great catch, thank you.

@JeffBezanson JeffBezanson added the status:help wanted Indicates that a maintainer wants help on an issue or pull request label Jul 25, 2018
JeffBezanson added a commit that referenced this issue Jul 26, 2018
JeffBezanson added a commit that referenced this issue Jul 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation status:help wanted Indicates that a maintainer wants help on an issue or pull request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants