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

Links to routines not included in documentation #182

Closed
jacobwilliams opened this issue Nov 23, 2016 · 2 comments
Closed

Links to routines not included in documentation #182

jacobwilliams opened this issue Nov 23, 2016 · 2 comments

Comments

@jacobwilliams
Copy link
Member

Say we want to keep our options open for generating documentation including the private procedures or not. Currently in the documentation for public routines, if the private routines are not included, the [[blah]] style links to private routines are rendered just like that ([[blah]]). I was wondering if instead, it would look better to use a different font style or something (maybe just bold or italics)? Something to set them apart but not including the brackets (which makes it look like some kind of mistake to me).

@cmacmackin
Copy link
Contributor

That should be perfectly doable. Sorry for the lack of activity on my
part lately--I've been insanely busy with term. Hopefully I can squash a
few bugs/feature requests over Christmas, assuming I don't have to spend
too much time doing other work.

On 23/11/16 02:59, Jacob Williams wrote:

Say we want to keep our options open for generating documentation
including the |private| procedures or not. Currently in the
documentation for public routines, if the private routines are not
included, the |[[blah]]| style links to private routines are rendered
just like that (|[[blah]]|). I was wondering if instead, it would look
better to use a different font style or something (maybe just bold or
italics)? Something to set them apart but not including the brackets
(which makes it look like some kind of mistake to me).


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
https://github.com/cmacmackin/ford/issues/182, or mute the thread
https://github.com/notifications/unsubscribe-auth/AHxJPVt26hqf2TG1hfAkX_5ZQjm1hiHyks5rA6wmgaJpZM4K6LVP.

Chris MacMackin
cmacmackin.github.io https://cmacmackin.github.io

@cmacmackin
Copy link
Contributor

cmacmackin commented Dec 30, 2017

Add this and it will be in the next release. When a link can't be found it will now have the form <a>blah</a>, i.e. it will be a link which doesn't lead anywhere or do anything. For certain classes of errors, when invalid syntax is used, [[blah]] will be shown as before.

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