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

[BUG] Usage docs do not test for library name prefix on test files #651

Open
hdwalters opened this issue Dec 28, 2024 · 0 comments · May be fixed by #653
Open

[BUG] Usage docs do not test for library name prefix on test files #651

hdwalters opened this issue Dec 28, 2024 · 0 comments · May be fixed by #653
Assignees
Labels
bug Something isn't working

Comments

@hdwalters
Copy link
Contributor

Describe the bug
As part of the standard library rename in pull request #639, we renamed the integration test files to match the new standard library function names, and added the library name as a prefix if missing. For example, function text_contains is tested in file text_contains.ab, but replace is tested in text_replace.ab. However, when we run amber docs --usage, we find all test files matching replace*.ab, but not text_replace*.ab.

To Reproduce
Run amber docs --usage src/std/text.ab.

Expected behavior

  • The usage docs should reference the prefixed as well as the unprefixed test files.
  • While I'm at it, I would also like to remove the excess blank lines from the generated Markdown files, as we inconsistently use one, two or three newlines, depending on context.
  • Finally, I would like to make amber docs text.ab write to standard output if the specified output directory is -; this will make testing changes simpler.

Additional context
N/A

@hdwalters hdwalters added the bug Something isn't working label Dec 28, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in Amber Project Dec 28, 2024
@hdwalters hdwalters self-assigned this Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant