-
Notifications
You must be signed in to change notification settings - Fork 29
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
Would it be possible to add a TYPEDMETHODLIST abbreviation #150
Labels
Comments
Hi @unnamedunknownusername, yes, seems like a reasonable addition.
Go for it. If you need any help just ping me in the work-in-progress PR once you get going I'll give you some guidance where needed. |
draft PR is up #153 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently I have a module set up like this
myFunc1.jl
file looks like thisThis does 99% of what I want it to. i.e. DocStringExtensions correctly adds the
![image](https://private-user-images.githubusercontent.com/109242984/238186407-d6459419-e9b4-47bf-aa5c-f630c2a64c58.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA5NzE5ODUsIm5iZiI6MTcyMDk3MTY4NSwicGF0aCI6Ii8xMDkyNDI5ODQvMjM4MTg2NDA3LWQ2NDU5NDE5LWU5YjQtNDdiZi1hYTVjLWY2MzBjMmE2NGM1OC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwNzE0JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDcxNFQxNTQxMjVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04N2M2MmQ1Y2E3OTYwZWEzNDFjMWVkNjE5ZGJmMjczMTA2YWUzMTY3Y2Y2ZjJkZTBlMzk4MTMxNTlmOTQ5NDVhJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.5gBlXI7fTvzYIwZy4eKXvq1gruz4D1zJCsEUzeJWreI)
#Decription
and#Examples
heading and then adds each example as per the documentation above each method.However
![image](https://private-user-images.githubusercontent.com/109242984/238186479-74ab3f56-cf91-484c-910a-b7da76e7becf.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA5NzE5ODUsIm5iZiI6MTcyMDk3MTY4NSwicGF0aCI6Ii8xMDkyNDI5ODQvMjM4MTg2NDc5LTc0YWIzZjU2LWNmOTEtNDg0Yy05MTBhLWI3ZGE3NmU3YmVjZi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwNzE0JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDcxNFQxNTQxMjVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04OGZmYzJlMDA1ZjkwNWMyYTYzMjEwZTM2Y2UwNDlmODEwMjM2MmY0OWM1YzJmMDZkN2IxZWM4ZTBmZmM2YzA3JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.V-hBiQmNZPZDttSDcQIumnRJT5RaGART38CnQJYgsTE)
$METHODLIST
outputs thisso for the last two methods of
myFunc1
( one that takes in a string and the other that takes in a int) you can't see immediately what the input is because they both show up asNote I cannot do this with
TYPEDSIGNATURES
in each individual method docString as i specifically want a doc sting like thisWould it be possible to add the typed signatures/ typed method list by creating a new
$TYPEDMETHODLIST
abbreviation similar to how it is done for$TYPEDSIGNATURES
I could then create the module as described above and everything would show up nicely/just work. And I would be able to distinguish between which method is which
I would be happy to contribute to a PR. I am a novice when it comes to meta-programming so guidance on what to do/where to look would be appreciated
Many thanks in advance
The text was updated successfully, but these errors were encountered: