Skip to content

use numeric slug for linking #316

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

use numeric slug for linking #316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions aep/general/0200/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ each exception so that historical wisdom is not lost.

If an API violates "**should**" or "**should not**" AEP guidance for any
reason, there **must** be an internal comment linking to this document using
its descriptive link ([aep.dev/not-precedent]()) to ensure others do not copy
its descriptive link ([aep.dev/200]()) to ensure others do not copy
the violations or cite the errors as precedent of a "previously approved API".

**Important:** APIs **must not** violate guidance specified with "**must**" or
Expand All @@ -40,14 +40,14 @@ why it is necessary. For example:
message DailyMaintenanceWindow {
// Time within the maintenance window to start the maintenance operations.
// It must use the format "HH MM", where HH : [00-23] and MM : [00-59] GMT.
// (-- aep.dev/not-precedent: This was designed for consistency with crontab,
// (-- aep.dev/200: This was designed for consistency with crontab,
// and preceded the AEP standards.
// Ordinarily, this type should be `aep.type.TimeOfDay`. --)
string start_time = 2;

// Output only. Duration of the time window, automatically chosen to be
// smallest possible in the given scenario.
// (-- aep.dev/not-precedent: This preceded the AEP standards.
// (-- aep.dev/200: This preceded the AEP standards.
// Ordinarily, this type should be `google.protobuf.Duration`. --)
string duration = 3;
}
Expand Down Expand Up @@ -81,15 +81,15 @@ new APIs.
```proto
// ...
message Book {
// (-- aep.dev/not-precedent: This field was present before there was a
// (-- aep.dev/200: This field was present before there was a
// standard field.
// Ordinarily, it should be spelled `create_time`. --)
google.protobuf.Timestamp creation_time = 1;
}

// ...
message Author {
// (-- aep.dev/not-precedent: `Book` had `creation_time` before there was
// (-- aep.dev/200: `Book` had `creation_time` before there was
// a standard field, so we match that here for consistency. Ordinarily,
// this would be spelled `create_time`. --)
google.protobuf.Timestamp creation_time = 1;
Expand Down
Loading