Mixing
How to add an example into the Variables section of the godoc documentation
I'm looking for a way to add an example linked automatically to a Variable in my GoDoc:
I have tried to create an example function in order to have it linked automatically by GoDoc to IsAValidQualifier into the Variables section of the documentation... But I cannot figure how to do this!
Here the content of my file qualified_name.go
package model
//...
// This is the variable where I want the to link the example
var IsAValidQualifier = regexp.MustCompile(`some_regexp_content...`).MatchString
func ValidQualifiedName(s string) bool {
return IsAValidQualifier(s)
}
I'm able to created an example for the ValidQualifiedName method doing this in a file called qualified_name_test.go
func ExampleQualifiedName_ValidQualifiedName() {
// The example content
}
In the same qualified_name_test.go file I have tried to add something like :
func ExampleIsAValidQualifier() {
// The example content
}
But without any result, except the fact that my example appears into the Examples section and the link on it point nowhere.
I have also tried to do the same changing my test file to model_test.go, but still not results...
Because the variable refers to the function MatchString(s string) bool I have even tried
func ExampleIsAValidQualifier_MatchString() {
// The example content
}
But sadly still no luck with that...
I know that is not the usual case to use example but at the end my variable refers to a function so it would have be nice to be able to use it and document it properly without adding an extra function like ValidQualifiedName(s string).
Then my questions are, can we do that; did I missed something?
go godoc
edited Nov 22 '18 at 13:13
Flimzy
39k106597
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
add a comment |
I'm looking for a way to add an example linked automatically to a Variable in my GoDoc:
I have tried to create an example function in order to have it linked automatically by GoDoc to IsAValidQualifier into the Variables section of the documentation... But I cannot figure how to do this!
Here the content of my file qualified_name.go
package model
//...
// This is the variable where I want the to link the example
var IsAValidQualifier = regexp.MustCompile(`some_regexp_content...`).MatchString
func ValidQualifiedName(s string) bool {
return IsAValidQualifier(s)
}
I'm able to created an example for the ValidQualifiedName method doing this in a file called qualified_name_test.go
func ExampleQualifiedName_ValidQualifiedName() {
// The example content
}
In the same qualified_name_test.go file I have tried to add something like :
func ExampleIsAValidQualifier() {
// The example content
}
But without any result, except the fact that my example appears into the Examples section and the link on it point nowhere.
I have also tried to do the same changing my test file to model_test.go, but still not results...
Because the variable refers to the function MatchString(s string) bool I have even tried
func ExampleIsAValidQualifier_MatchString() {
// The example content
}
But sadly still no luck with that...
I know that is not the usual case to use example but at the end my variable refers to a function so it would have be nice to be able to use it and document it properly without adding an extra function like ValidQualifiedName(s string).
Then my questions are, can we do that; did I missed something?
go godoc
edited Nov 22 '18 at 13:13
Flimzy
39k106597
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
2
As much as I know there are no examples for variables, so: Undoable with the current godoc.
– Volker
Nov 22 '18 at 10:13
add a comment |
I'm looking for a way to add an example linked automatically to a Variable in my GoDoc:
I have tried to create an example function in order to have it linked automatically by GoDoc to IsAValidQualifier into the Variables section of the documentation... But I cannot figure how to do this!
Here the content of my file qualified_name.go
package model
//...
// This is the variable where I want the to link the example
var IsAValidQualifier = regexp.MustCompile(`some_regexp_content...`).MatchString
func ValidQualifiedName(s string) bool {
return IsAValidQualifier(s)
}
I'm able to created an example for the ValidQualifiedName method doing this in a file called qualified_name_test.go
func ExampleQualifiedName_ValidQualifiedName() {
// The example content
}
In the same qualified_name_test.go file I have tried to add something like :
func ExampleIsAValidQualifier() {
// The example content
}
But without any result, except the fact that my example appears into the Examples section and the link on it point nowhere.
I have also tried to do the same changing my test file to model_test.go, but still not results...
Because the variable refers to the function MatchString(s string) bool I have even tried
func ExampleIsAValidQualifier_MatchString() {
// The example content
}
But sadly still no luck with that...
I know that is not the usual case to use example but at the end my variable refers to a function so it would have be nice to be able to use it and document it properly without adding an extra function like ValidQualifiedName(s string).
Then my questions are, can we do that; did I missed something?
go godoc
edited Nov 22 '18 at 13:13
Flimzy
39k106597
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
I'm looking for a way to add an example linked automatically to a Variable in my GoDoc:
I have tried to create an example function in order to have it linked automatically by GoDoc to IsAValidQualifier into the Variables section of the documentation... But I cannot figure how to do this!
Here the content of my file qualified_name.go
package model
//...
// This is the variable where I want the to link the example
var IsAValidQualifier = regexp.MustCompile(`some_regexp_content...`).MatchString
func ValidQualifiedName(s string) bool {
return IsAValidQualifier(s)
}
I'm able to created an example for the ValidQualifiedName method doing this in a file called qualified_name_test.go
func ExampleQualifiedName_ValidQualifiedName() {
// The example content
}
In the same qualified_name_test.go file I have tried to add something like :
func ExampleIsAValidQualifier() {
// The example content
}
But without any result, except the fact that my example appears into the Examples section and the link on it point nowhere.
I have also tried to do the same changing my test file to model_test.go, but still not results...
Because the variable refers to the function MatchString(s string) bool I have even tried
func ExampleIsAValidQualifier_MatchString() {
// The example content
}
But sadly still no luck with that...
I know that is not the usual case to use example but at the end my variable refers to a function so it would have be nice to be able to use it and document it properly without adding an extra function like ValidQualifiedName(s string).
Then my questions are, can we do that; did I missed something?
go godoc
go godoc
edited Nov 22 '18 at 13:13
Flimzy
39k106597
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
edited Nov 22 '18 at 13:13
Flimzy
39k106597
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
edited Nov 22 '18 at 13:13
Flimzy
39k106597
edited Nov 22 '18 at 13:13
Flimzy
39k106597
edited Nov 22 '18 at 13:13
Flimzy
39k106597
39k106597
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
asked Nov 22 '18 at 9:41
NirekinNirekin
3,35111742
3,35111742
2
As much as I know there are no examples for variables, so: Undoable with the current godoc.
– Volker
Nov 22 '18 at 10:13
add a comment |
2
As much as I know there are no examples for variables, so: Undoable with the current godoc.
– Volker
Nov 22 '18 at 10:13
2
2
As much as I know there are no examples for variables, so: Undoable with the current godoc.
– Volker
Nov 22 '18 at 10:13
As much as I know there are no examples for variables, so: Undoable with the current godoc.
– Volker
Nov 22 '18 at 10:13
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53427919%2fhow-to-add-an-example-into-the-variables-section-of-the-godoc-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53427919%2fhow-to-add-an-example-into-the-variables-section-of-the-godoc-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
2
As much as I know there are no examples for variables, so: Undoable with the current godoc.
– Volker
Nov 22 '18 at 10:13