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

Attaching docs to call overloading (self::Objectt)(a,b,c) #228

Closed
vchuravy opened this issue Aug 22, 2016 · 2 comments
Closed

Attaching docs to call overloading (self::Objectt)(a,b,c) #228

vchuravy opened this issue Aug 22, 2016 · 2 comments

Comments

@vchuravy
Copy link
Contributor

This code errors with the cryptic message:

ERROR: LoadError: UndefVarError: self not defined
 in category(::Base.Docs.Binding) at /home/wallnuss/.julia/v0.6/Documenter/src/DocSystem.jl:383
 in runner(::Type{Documenter.Expanders.AutoDocsBlocks}, ::Base.Markdown.Code, ::Documenter.Documents.Page, ::Documenter.Documents.Document) at /home/wallnuss/.julia/v0.6/Documenter/src/Expanders.jl:327
 in dispatch(::Type{Documenter.Expanders.ExpanderPipeline}, ::Base.Markdown.Code, ::Documenter.Documents.Page, ::Documenter.Documents.Document) at /home/wallnuss/.julia/v0.6/Documenter/src/Selectors.jl:164
 in expand(::Documenter.Documents.Document) at /home/wallnuss/.julia/v0.6/Documenter/src/Expanders.jl:29
 in dispatch(::Type{Documenter.Builder.DocumentPipeline}, ::Documenter.Documents.Document) at /home/wallnuss/.julia/v0.6/Documenter/src/Selectors.jl:164
 in cd(::Documenter.##2#3{Documenter.Documents.Document}, ::String) at ./file.jl:59
 in #makedocs#1(::Bool, ::Array{Any,1}, ::Function) at /home/wallnuss/.julia/v0.6/Documenter/src/Documenter.jl:156
 in (::Documenter.#kw##makedocs)(::Array{Any,1}, ::Documenter.#makedocs) at ./<missing>:0
 in include_from_node1(::String) at ./loading.jl:426
 in process_options(::Base.JLOptions) at ./client.jl:262
 in _start() at ./client.jl:318
while loading /home/wallnuss/src/MXNet.jl/docs/make.jl, in expression starting on line 3
 """
      call(self :: SymbolicNode, args :: SymbolicNode...)
      call(self :: SymbolicNode; kwargs...)

  Make a new node by composing `self` with `args`. Or the arguments
  can be specified using keyword arguments.
"""
@compat function (self::SymbolicNode)(args :: SymbolicNode...)
end

see dmlc/MXNet.jl#118

@vchuravy vchuravy changed the title Attaching docs to Attaching docs to call overloading (self::Objectt)(a,b,c) Aug 22, 2016
@MichaelHatherly
Copy link
Member

Documenting call syntax is not supported by the docsystem at the moment, since there isn't a particular named object that the docstring should be attached to, i.e. it is trying to document an instance of a named object SymbolicNode rather than SymbolicNode itself. I've not yet come up with a decent approach to supporting this without needing to special case a bunch of things in the docsystem.

@MichaelHatherly
Copy link
Member

(Closing since there's not much that can be done within Documenter itself to change this).

navidcy added a commit to CliMA/Oceananigans.jl that referenced this issue Jul 14, 2021
glwagner added a commit to CliMA/Oceananigans.jl that referenced this issue Jul 15, 2021
* Reworking FieldBoundaryConditions

* Refactors FieldBoundaryConditions

* Fixes many tests

* More test fixes

* Update docs/src/model_setup/boundary_conditions.md

Co-authored-by: Navid C. Constantinou <[email protected]>

* Nuke AuxiliaryFieldBoundaryConditions; just use special FieldBoundaryConditions

* No more x, y, z, right, left...

* Banish DiffusivityBoundaryConditions

* Banish CoordinateBoundaryConditions

* Fixes boundary condition test with ContinuousBoundaryFunction

* Adds better default bcs for VelocityFields and TracerFields

* New syntax!

* Iterate better over boundary conditions

* Fixes bug in field_boundary_conditions

* Fix TracerFields implementation

* Were not ready for zero flux boundary conditions...

* Fixes bottom-top mix up

* Fixes broken ref to Nx in Poisson solver test

* Default for ZFaceField was changed so now broadcasting tests need to be changed too

* Fix regularize_boundary_condition for CubedSpheres

* West vs east

* Fix issues with TKEBasedVerticalDiffusivity

* Fiddling with AMD boundary conditions

* Adds regularize_boundary_conditions for regular bcs on ConformalCubedSphereGrid

* Fixes bug in determining tracer diffusivity bcs with AMD

* Adds location to FieldBoundaryConditions for broadcasting test

* Properly inject CubedSphere exchange bcs during regularization

* Adds a method for nested NamedTuple boundary conditions

* Fixes VelocityFields constructor to use valid regularized boundary conditions

* Updates to new syntax for stratified couette flow

* Elide tendency fields when velocities are prescribed

* Import regularize_boundary_conditions into field_tuples

* Try 2 with poisson solver test refactor

* Simplifies default calculation

* Fixes ommission of tracer tendencies when using prescribed velocities

* Import regularize_field_boundary_conditions into poisson solver tests

* Eta is prognostic, not w

* Adds missing comma in show methods

* Fix doctests

* Fix doctests

* Fix doctests

* Fix docstring in Field constructor

* Use FluxBoundaryCondition

* Where bc?

* Ancient issues with library.md

* Comments out library to see what happens

* Deletes misleading and impertinent comments

* Bump to 0.59.0

* Comments out appendix in docs

* Cleans up BoundaryConditions code + docstrings

* Docs despration

* update BoundaryConditions pages

* can't document call syntax; see JuliaDocs/Documenter.jl#228

* back to including everything

* improves some docstrings

* Updates validation experiments

* Fixes typos in TKEBasedVerticalMixing validation

Co-authored-by: Navid C. Constantinou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants