Skip to content

System functions: Split ambivalent pages into separate monadic and dyadic pages #957

Description

@FionaDyalog

40 of the system functions are currently documented in their ambivalent forms. These should be split into their monadic and dyadic forms.

For each of the 40, this involves:

  • Copying the existing file. The filename convention to use is: foo-monadic.md and foo-dyadic.md, where "foo" is the letters in the system function. For example, nget-monadic.md
  • Editing the two files so that one is specifically for the monadic form and one specifically for the dyadic form.
  • Creating a disambiguation page. The filename convention to use is: foo-disambiguation.md
  • Updating the .yml file to include the two entries
  • Searching for any cross-references in the documentation set and updating them as appropriate (should not be to the disambiguation page unless unavoidable).

In addition, help_urls.h in SVN/docbin needs to be updated with the new references to the disambiguation pages. This must be committed at the same time as the other changes are merged as otherwise the build will break.

Note that this issue is not about sorting all the issues with system functions, just the parts listed above. There are other issues that have been raised under the same milestone that will resolve the other issues. This is the first of the related issues that should be worked on.

The attached document lists the 40 functions and the titles for the pages/ToC.

Note that it might be easier to do this in multiple tranches, but all the steps above must be completed for each one within the same tranche.

This issue does not require a technical review but ought to be reviewed by me please (others can review too if required).

sysfn_disambiguation.xlsx

Metadata

Metadata

Assignees

Labels

lang-ref-guideDocument: Dyalog APL Language Reference Guide

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions