Summary

Fix Bitbucket repo name description error.

Review Request #10150 — Created Sept. 21, 2018 and submitted Oct. 16, 2018, 3:19 p.m.

Information

Owner

skaefer143

Repository

Review Board

Branch

master

Bugs

4664

Depends On

Commit

5cb2d40...

Reviewers

Groups

reviewboard, students

People

Description

When adding a repository as an admin, and choosing Bitbucket as a
hosting service, an incorrect repository name description displays.
In the "Repository Name" description, when using the "Personal"
repository plan, the description would read "The username of the
user who owns the repository. This is the <repo_name> in
https://bitbucket.org/<username>/<repo_name>/". This isn't correct.

It now reads "The name of the repository. This is the <repo_name> in
https://bitbucket.org/<username>/<repo_name>/".

Testing Done

Tested by refreshing the page, and confirmed that the "Repository
Name" description is the new description. Also, navigated to
http://localhost:8080/admin/, clicked on "Add +" under Repositories,
and confirmed that on
http://localhost:8080/admin/db/scmtools/repository/add/ the
description text has changed.

No other description fields have changed.

Issues

Description	From	Last Updated
Please wrap your description and testing done fields at 72 columns (these turn into the commit message when we land …	david	Sept. 21, 2018, 10:16 a.m.
The change looks great! This comment is about the Testing Done. You're very descriptive, and that's always a great place …	chipx86	Sept. 23, 2018, 6:33 a.m.
Can you rewrap the strings in here to use up to 80 columns? We can probably make this be 3 …	david	Sept. 22, 2018, 6:28 a.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Please wrap your description and testing done fields at 72 columns (these turn into the commit message when we land it).

reviewboard/hostingsvcs/bitbucket.py (Diff revision 1)

The issue has been resolved. Show all issues

Can you rewrap the strings in here to use up to 80 columns? We can probably make this be 3 lines instead of 4 now.

skaefer143 Sept. 21, 2018, 10:17 a.m.

Should I change lines 86-89 and 107-110 to also use 3 lines, to be consistent?

mike_conley Sept. 21, 2018, 10:22 a.m.

I'm not certain you can, can you? That bitbucket.org URL, I think, will bring us over the 80 char limit.

skaefer143 Sept. 21, 2018, 10:28 a.m.

It's not a URL in a comment, so I assumed you could split the URL up. It's possible to split the string into 3 lines with the URL and still stay within the 80 char limit.

Change Summary:: Wrapped Description and Testing Done text to 72 columns.
Description:: ~
When adding a repository as an admin, and choosing Bitbucket as a hosting service, an incorrect repository name description displays. In the "Repository Name" description, when using the "Personal" repository plan, the description would read "The username of the user who owns the repository. This is the <repo_name> in https://bitbucket.org/<username>/<repo_name>/". This isn't correct.
~
When adding a repository as an admin, and choosing Bitbucket as a
+ hosting service, an incorrect repository name description displays.
+ In the "Repository Name" description, when using the "Personal"
+ repository plan, the description would read "The username of the
+ user who owns the repository. This is the <repo_name> in
+ https://bitbucket.org/<username>/<repo_name>/". This isn't correct.

~
It now reads "The name of the repository. This is the <repo_name> in https://bitbucket.org/<username>/<repo_name>/".
~
It now reads "The name of the repository. This is the <repo_name> in
+ https://bitbucket.org/<username>/<repo_name>/".
Testing Done:: ~
Tested by refreshing the page, and confirmed that the "Repository Name" description is the new description. Also, navigated to http://localhost:8080/admin/, clicked on "Add +" under Repositories, and confirmed that on http://localhost:8080/admin/db/scmtools/repository/add/ the description text has changed.
~
Tested by refreshing the page, and confirmed that the "Repository
+ Name" description is the new description. Also, navigated to
+ http://localhost:8080/admin/, clicked on "Add +" under Repositories,
+ and confirmed that on
+ http://localhost:8080/admin/db/scmtools/repository/add/ the
+ description text has changed.

No other description fields have changed.

~
All the functioning JS tests pass as well. There are 6 (known) tests that do not pass.
~
All the functioning JS tests pass as well. There are 6 (known)
+ tests that do not pass.

Commit:

6dc66d8b170f7f863c3688da30dd509057f44555

5cb2d4084e72d91480910ef36eac67df27066b33

Diff:

Revision 2 (+3 -4)

Show changes

reviewboard/hostingsvcs/bitbucket.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Looks good, thanks Storm!
```

The issue has been resolved. Show all issues

The change looks great! This comment is about the Testing Done. You're very descriptive, and that's always a great place to start from.

The one thing you can probably get rid of is the bit about unit tests, since we don't actually test any of this (and the code being modified isn't client-side code). If anything, it'd be Python unit tests you'd care about, but we don't test help text.

You mention the "6 known tests that do not pass," but this isn't really going to be useful information later. It's just a small detail of the state of those tests, but if I had to dig into the history of changes later and saw this, I wouldn't know how related this was to those test failures.

So in this case, I'd just leave off the unit test information.

Ship it!

```
Once Christian is happy, I'm happy :)
```

Testing Done:: Tested by refreshing the page, and confirmed that the "Repository
Name" description is the new description. Also, navigated to
http://localhost:8080/admin/, clicked on "Add +" under Repositories,
and confirmed that on
http://localhost:8080/admin/db/scmtools/repository/add/ the
description text has changed.

No other description fields have changed.
-
-
All the functioning JS tests pass as well. There are 6 (known)
- tests that do not pass.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (64ab20b)

~		When adding a repository as an admin, and choosing Bitbucket as a hosting service, an incorrect repository name description displays. In the "Repository Name" description, when using the "Personal" repository plan, the description would read "The username of the user who owns the repository. This is the <repo_name> in https://bitbucket.org/<username>/<repo_name>/". This isn't correct.
	~	When adding a repository as an admin, and choosing Bitbucket as a
	+	hosting service, an incorrect repository name description displays.
	+	In the "Repository Name" description, when using the "Personal"
	+	repository plan, the description would read "The username of the
	+	user who owns the repository. This is the <repo_name> in
	+	https://bitbucket.org/<username>/<repo_name>/". This isn't correct.

~		It now reads "The name of the repository. This is the <repo_name> in https://bitbucket.org/<username>/<repo_name>/".
	~	It now reads "The name of the repository. This is the <repo_name> in
	+	https://bitbucket.org/<username>/<repo_name>/".

~		Tested by refreshing the page, and confirmed that the "Repository Name" description is the new description. Also, navigated to http://localhost:8080/admin/, clicked on "Add +" under Repositories, and confirmed that on http://localhost:8080/admin/db/scmtools/repository/add/ the description text has changed.
	~	Tested by refreshing the page, and confirmed that the "Repository
	+	Name" description is the new description. Also, navigated to
	+	http://localhost:8080/admin/, clicked on "Add +" under Repositories,
	+	and confirmed that on
	+	http://localhost:8080/admin/db/scmtools/repository/add/ the
	+	description text has changed.

		No other description fields have changed.

~		All the functioning JS tests pass as well. There are 6 (known) tests that do not pass.
	~	All the functioning JS tests pass as well. There are 6 (known)
	+	tests that do not pass.