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

Fully qualified references do not work #3

Open
oberstet opened this issue Nov 24, 2018 · 4 comments
Open

Fully qualified references do not work #3

oberstet opened this issue Nov 24, 2018 · 4 comments

Comments

@oberstet
Copy link

As this is the first issue in this repo, let me first say: kudos for creating this project! It is very useful, thank you for sharing your work. It would be awesome to have it around and further progressing ..

Now I have a little itch .. yeah, people are always asking for more once you give them sth;)

I am trying to get references to work, e.g. :sol:func:XBRNetwork.registershould create a link to the respective documentation that was generated from.. autosolcontract:: XBRNetwork`, however I get:

overview.rst:13: WARNING: sol:func reference target not found: XBRNetwork.register
@cag
Copy link
Owner

cag commented Nov 24, 2018

I agree. It's hard to juggle everything qq

Also, thanks!

@cag cag mentioned this issue Dec 10, 2018
@cag cag closed this as completed in #7 Dec 10, 2018
@cag
Copy link
Owner

cag commented Dec 10, 2018

@oberstet Should work in 0.5.0

@oberstet
Copy link
Author

Just tested 0.5.1, and referencing contracts works as expected. cool, thanks for coming back to this!

Referencing functions has a glitch though (I think) .. using this as a test:

**TEST 1**: :sol:func:`register`

**TEST 2**: :sol:func:`XBRNetwork.register`

**TEST 3**: ``XBRNetwork``:sol:func:`register`

the first one correctly references the intended target function - there is only one named register in all of the contracts documented.

What if a different function with the same name exists in more than one contract?

The 2nd version does not work, but isn't that the format one usually is expected to use (fully qualified function names)?

The 3rd form is a workaround to at least render the text "fully qualified function name" - well;)

@cag
Copy link
Owner

cag commented Dec 17, 2018

@oberstet Yeah... I kinda just threw that together in the most basic fashion, so it is definitely not as full featured as some other domains right now 😅

@cag cag reopened this Dec 17, 2018
@cag cag changed the title References do not seem to work Fully qualified references do not work Dec 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants