[m-rev.] for review: links for asking good questions

Julien Fischer jfischer at opturion.com
Sat Oct 22 22:33:56 AEDT 2022



On Sat, 22 Oct 2022, Zoltan Somogyi wrote:

>
>
> On Sat, 22 Oct 2022 19:34:26 +1100 (AEDT), Julien Fischer <jfischer at opturion.com> wrote:
>
>>
>> On Sat, 22 Oct 2022, Zoltan Somogyi wrote:
>>
>>> For review by anyone.

> diff --git a/documentation/papers/acsc95_slides.ps.gz b/documentation/papers/acsc95_slides.ps.gz
> index 0ddaf45..568f2de 100644
> Binary files a/documentation/papers/acsc95_slides.ps.gz and b/documentation/papers/acsc95_slides.ps.gz differ
> diff --git a/documentation/papers/hlc_cc_perf.tar.gz b/documentation/papers/hlc_cc_perf.tar.gz
> index 47978ef..e6cc0b2 100644
> Binary files a/documentation/papers/hlc_cc_perf.tar.gz and b/documentation/papers/hlc_cc_perf.tar.gz differ
> diff --git a/include/contact.inc b/include/contact.inc
> index ca2b66e..822c053 100644
> --- a/include/contact.inc
> +++ b/include/contact.inc

...

> @@ -16,8 +16,31 @@ If sending a bug report, please enclose as much information as possible,
>  including, if possible source code (such as a small test case that exhibits the
>  bug), any error messages encountered, operating system version, and
>  configuration information, compiler flags used and Mercury compiler version.
> -Also, you might want to check the current release to see if a newer release is
> -available, or see the bug tracker to see if the bug has already been reported.
> +Also, you might want to check whether a newer release is available,
> +or check in our bug tracker whether the bug has already been reported.
> +</p>
> +
> +<p>
> +For more detailed information about how to write bug reports
> +that help you as well helping us, see these links:
> +<ul class="nonindentlist">
> +<li>
> +<a href="https://princetonuniversity.github.io/PUbootcamp/sessions/technical-questions/HowToAskQuestions2018Bootcamp.pdf">
> +link 1</a?

Fix the closing tag there.

> +<li>
> +<a href="https://www.theodinproject.com/how_to_as">

That link just returns a 404.

> +link 2</a>
> +<li>
> +<a href="https://xyproblem.info">
> +link 3</a>
> +<li>
> +<a href="https://www.timbuchalka.com/post/how-to-ask-a-technical-question-the-right-way">
> +link 4</a>
> +<li>
> +<a href="https://www.webucator.com/article/how-to-ask-good-technical-questions">
> +link 5</a>
> +</ul>
> +These links were current as of 2022 October.
>  </p>

I suggest that instead of link 1, link 2 etc. you use the titles of the
documents that you are linking to.

That looks fine otherwise.

Julien.


More information about the reviews mailing list